/* --------------------------------------------------------------------------- Open Asset Import Library (ASSIMP) --------------------------------------------------------------------------- Copyright (c) 2006-2008, ASSIMP Development Team All rights reserved. Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the ASSIMP team, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of the ASSIMP Development Team. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. --------------------------------------------------------------------------- */ /** @file DefaultLogger.cpp * @brief Implementation of DefaultLogger (and Logger) */ #include "AssimpPCH.h" #include "DefaultIOSystem.h" // Default log streams #include "Win32DebugLogStream.h" #include "StdOStreamLogStream.h" #include "FileLogStream.h" namespace Assimp { // ---------------------------------------------------------------------------------- NullLogger DefaultLogger::s_pNullLogger; Logger *DefaultLogger::m_pLogger = &DefaultLogger::s_pNullLogger; // ---------------------------------------------------------------------------------- // Represents a logstream + its error severity struct LogStreamInfo { unsigned int m_uiErrorSeverity; LogStream *m_pStream; // Constructor LogStreamInfo( unsigned int uiErrorSev, LogStream *pStream ) : m_uiErrorSeverity( uiErrorSev ), m_pStream( pStream ) { // empty } // Destructor ~LogStreamInfo() { // empty } }; // ---------------------------------------------------------------------------------- // Construct a default log stream LogStream* LogStream::createDefaultStream(DefaultLogStreams streams, const char* name /*= "AssimpLog.txt"*/, IOSystem* io /*= NULL*/) { switch (streams) { // This is a platform-specific feature case DLS_DEBUGGER: #ifdef WIN32 return new Win32DebugLogStream(); #else return NULL; #endif // Platform-independent default streams case DLS_CERR: return new StdOStreamLogStream(std::cerr); case DLS_COUT: return new StdOStreamLogStream(std::cout); case DLS_FILE: return (name && *name ? new FileLogStream(name,io) : NULL); default: // We don't know this default log stream, so raise an assertion ai_assert(false); }; // For compilers without dead code path detection return NULL; } // ---------------------------------------------------------------------------------- // Creates the only singleton instance Logger *DefaultLogger::create(const char* name /*= "AssimpLog.txt"*/, LogSeverity severity /*= NORMAL*/, unsigned int defStreams /*= DLS_DEBUGGER | DLS_FILE*/, IOSystem* io /*= NULL*/) { if (m_pLogger && !isNullLogger() ) delete m_pLogger; m_pLogger = new DefaultLogger( severity ); // Attach default log streams // Stream the log to the MSVC debugger? if (defStreams & DLS_DEBUGGER) m_pLogger->attachStream( LogStream::createDefaultStream(DLS_DEBUGGER)); // Stream the log to COUT? if (defStreams & DLS_COUT) m_pLogger->attachStream( LogStream::createDefaultStream(DLS_COUT)); // Stream the log to CERR? if (defStreams & DLS_CERR) m_pLogger->attachStream( LogStream::createDefaultStream(DLS_CERR)); // Stream the log to a file if (defStreams & DLS_FILE && name && *name) m_pLogger->attachStream( LogStream::createDefaultStream(DLS_FILE,name,io)); return m_pLogger; } // ---------------------------------------------------------------------------------- void Logger::debug(const std::string &message) { ai_assert(message.length()<=Logger::MAX_LOG_MESSAGE_LENGTH); return OnDebug(message.c_str()); } // ---------------------------------------------------------------------------------- void Logger::info(const std::string &message) { ai_assert(message.length()<=Logger::MAX_LOG_MESSAGE_LENGTH); return OnInfo(message.c_str()); } // ---------------------------------------------------------------------------------- void Logger::warn(const std::string &message) { ai_assert(message.length()<=Logger::MAX_LOG_MESSAGE_LENGTH); return OnWarn(message.c_str()); } // ---------------------------------------------------------------------------------- void Logger::error(const std::string &message) { ai_assert(message.length()<=Logger::MAX_LOG_MESSAGE_LENGTH); return OnError(message.c_str()); } // ---------------------------------------------------------------------------------- void DefaultLogger::set( Logger *logger ) { if (!logger)logger = &s_pNullLogger; if (m_pLogger && !isNullLogger() ) delete m_pLogger; DefaultLogger::m_pLogger = logger; } // ---------------------------------------------------------------------------------- bool DefaultLogger::isNullLogger() { return m_pLogger == &s_pNullLogger; } // ---------------------------------------------------------------------------------- // Singleton getter Logger *DefaultLogger::get() { return m_pLogger; } // ---------------------------------------------------------------------------------- // Kills the only instance void DefaultLogger::kill() { if (m_pLogger != &s_pNullLogger)return; delete m_pLogger; m_pLogger = &s_pNullLogger; } // ---------------------------------------------------------------------------------- // Debug message void DefaultLogger::OnDebug( const char* message ) { if ( m_Severity == Logger::NORMAL ) return; char msg[MAX_LOG_MESSAGE_LENGTH*2]; ::sprintf(msg,"Debug, T%i: %s", GetThreadID(), message ); WriteToStreams( msg, Logger::DEBUGGING ); } // ---------------------------------------------------------------------------------- // Logs an info void DefaultLogger::OnInfo( const char* message ) { char msg[MAX_LOG_MESSAGE_LENGTH*2]; ::sprintf(msg,"Info, T%i: %s", GetThreadID(), message ); WriteToStreams( msg , Logger::INFO ); } // ---------------------------------------------------------------------------------- // Logs a warning void DefaultLogger::OnWarn( const char* message ) { char msg[MAX_LOG_MESSAGE_LENGTH*2]; ::sprintf(msg,"Warn, T%i: %s", GetThreadID(), message ); WriteToStreams( msg, Logger::WARN ); } // ---------------------------------------------------------------------------------- // Logs an error void DefaultLogger::OnError( const char* message ) { char msg[MAX_LOG_MESSAGE_LENGTH*2]; ::sprintf(msg,"Error, T%i: %s", GetThreadID(), message ); WriteToStreams( msg, Logger::ERR ); } // ---------------------------------------------------------------------------------- // Severity setter void DefaultLogger::setLogSeverity( LogSeverity log_severity ) { m_Severity = log_severity; } // ---------------------------------------------------------------------------------- // Attachs a new stream void DefaultLogger::attachStream( LogStream *pStream, unsigned int severity ) { if (!pStream) return; // fix (Aramis) if (0 == severity) { severity = Logger::INFO | Logger::ERR | Logger::WARN | Logger::DEBUGGING; } for ( StreamIt it = m_StreamArray.begin(); it != m_StreamArray.end(); ++it ) { if ( (*it)->m_pStream == pStream ) { (*it)->m_uiErrorSeverity |= severity; return; } } LogStreamInfo *pInfo = new LogStreamInfo( severity, pStream ); m_StreamArray.push_back( pInfo ); } // ---------------------------------------------------------------------------------- // Detatch a stream void DefaultLogger::detatchStream( LogStream *pStream, unsigned int severity ) { if (!pStream) return; // fix (Aramis) if (0 == severity) { severity = Logger::INFO | Logger::ERR | Logger::WARN | Logger::DEBUGGING; } for ( StreamIt it = m_StreamArray.begin(); it != m_StreamArray.end(); ++it ) { if ( (*it)->m_pStream == pStream ) { (*it)->m_uiErrorSeverity &= ~severity; if ( (*it)->m_uiErrorSeverity == 0 ) { m_StreamArray.erase( it ); break; } } } } // ---------------------------------------------------------------------------------- // Constructor DefaultLogger::DefaultLogger(LogSeverity severity) : m_Severity ( severity ) , noRepeatMsg (false) {} // ---------------------------------------------------------------------------------- // Destructor DefaultLogger::~DefaultLogger() { for ( StreamIt it = m_StreamArray.begin(); it != m_StreamArray.end(); ++it ) delete *it; } // ---------------------------------------------------------------------------------- // Writes message to stream void DefaultLogger::WriteToStreams(const char *message, ErrorSeverity ErrorSev ) { ai_assert(NULL != message); // Check whether this is a repeated message if (! ::strncmp( message,lastMsg, lastLen-1)) { if (!noRepeatMsg) { noRepeatMsg = true; message = "Skipping one or more lines with the same contents\n"; } else return; } else { // append a new-line character to the message to be printed lastLen = ::strlen(message); ::memcpy(lastMsg,message,lastLen+1); ::strcat(lastMsg+lastLen,"\n"); message = lastMsg; noRepeatMsg = false; ++lastLen; } for ( ConstStreamIt it = m_StreamArray.begin(); it != m_StreamArray.end(); ++it) { if ( ErrorSev & (*it)->m_uiErrorSeverity ) (*it)->m_pStream->write( message); } } // ---------------------------------------------------------------------------------- // Returns thread id, if not supported only a zero will be returned. unsigned int DefaultLogger::GetThreadID() { // fixme: we can get this value via boost::threads #ifdef WIN32 return (unsigned int)::GetCurrentThreadId(); #else return 0; // not supported #endif } // ---------------------------------------------------------------------------------- } // !namespace Assimp