Logger.hpp

Go to the documentation of this file.

/*
Open Asset Import Library (assimp)
----------------------------------------------------------------------
 
Copyright (c) 2006-2020, assimp 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 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.
 
----------------------------------------------------------------------
*/
 
#ifndef INCLUDED_AI_LOGGER_H
#define INCLUDED_AI_LOGGER_H
 
#include <assimp/types.h>
#include <assimp/TinyFormatter.h>
 
namespace Assimp {
 
class LogStream;
 
// Maximum length of a log message. Longer messages are rejected.
#define MAX_LOG_MESSAGE_LENGTH 1024u
 
// ----------------------------------------------------------------------------------
class ASSIMP_API Logger
#ifndef SWIG
    : public Intern::AllocateFromAssimpHeap
#endif
{
public:
 
    // ----------------------------------------------------------------------
    enum LogSeverity {
        NORMAL,     
        DEBUG,      
        VERBOSE     
    };
 
    // ----------------------------------------------------------------------
    enum ErrorSeverity {
        Debugging   = 1,    
        Info        = 2,    
        Warn        = 4,    
        Err         = 8     
    };
 
public:
 
    virtual ~Logger();
 
    // ----------------------------------------------------------------------
    void debug(const char* message);
    void debug(const std::string &message);
 
    // ----------------------------------------------------------------------
    void verboseDebug(const char *message);
    void verboseDebug(const std::string &message);
 
    // ----------------------------------------------------------------------
    void info(const char* message);
    void info(const std::string &message);
 
    // ----------------------------------------------------------------------
    void warn(const char* message);
    void warn(const std::string &message);
 
    // ----------------------------------------------------------------------
    void error(const char* message);
    void error(const std::string &message);
 
    // ----------------------------------------------------------------------
    void setLogSeverity(LogSeverity log_severity);
 
    // ----------------------------------------------------------------------
    LogSeverity getLogSeverity() const;
 
    // ----------------------------------------------------------------------
    virtual bool attachStream(LogStream *pStream,
        unsigned int severity = Debugging | Err | Warn | Info) = 0;
 
    // ----------------------------------------------------------------------
    virtual bool detachStream(LogStream *pStream,
        unsigned int severity = Debugging | Err | Warn | Info) = 0;
 
protected:
    Logger() AI_NO_EXCEPT;
 
    explicit Logger(LogSeverity severity);
 
    // ----------------------------------------------------------------------
    virtual void OnDebug(const char* message)= 0;
 
    // ----------------------------------------------------------------------
    virtual void OnVerboseDebug(const char *message) = 0;
 
    // ----------------------------------------------------------------------
    virtual void OnInfo(const char* message) = 0;
 
    // ----------------------------------------------------------------------
    virtual void OnWarn(const char* essage) = 0;
 
    // ----------------------------------------------------------------------
    virtual void OnError(const char* message) = 0;
 
protected:
    LogSeverity m_Severity;
};
 
// ----------------------------------------------------------------------------------
//  Default constructor
inline
Logger::Logger() AI_NO_EXCEPT
: m_Severity(NORMAL) {
    // empty
}
 
// ----------------------------------------------------------------------------------
//  Virtual destructor
inline
Logger::~Logger() {
    // empty
}
 
// ----------------------------------------------------------------------------------
// Construction with given logging severity
inline
Logger::Logger(LogSeverity severity)
: m_Severity(severity) {
    // empty
}
 
// ----------------------------------------------------------------------------------
// Log severity setter
inline
void Logger::setLogSeverity(LogSeverity log_severity){
    m_Severity = log_severity;
}
 
// ----------------------------------------------------------------------------------
// Log severity getter
inline
Logger::LogSeverity Logger::getLogSeverity() const {
    return m_Severity;
}
 
// ----------------------------------------------------------------------------------
inline
void Logger::debug(const std::string &message) {
    return debug(message.c_str());
}
 
// ----------------------------------------------------------------------------------
inline void Logger::verboseDebug(const std::string &message) {
    return verboseDebug(message.c_str());
}
 
// ----------------------------------------------------------------------------------
inline
void Logger::error(const std::string &message) {
    return error(message.c_str());
}
 
// ----------------------------------------------------------------------------------
inline
void Logger::warn(const std::string &message) {
    return warn(message.c_str());
}
 
// ----------------------------------------------------------------------------------
inline
void Logger::info(const std::string &message) {
    return info(message.c_str());
}
 
} // Namespace Assimp
 
// ------------------------------------------------------------------------------------------------
#define ASSIMP_LOG_WARN_F(string, ...) \
    Assimp::DefaultLogger::get()->warn((Assimp::Formatter::format(string), __VA_ARGS__))
 
#define ASSIMP_LOG_ERROR_F(string, ...) \
    Assimp::DefaultLogger::get()->error((Assimp::Formatter::format(string), __VA_ARGS__))
 
#define ASSIMP_LOG_DEBUG_F(string, ...) \
    Assimp::DefaultLogger::get()->debug((Assimp::Formatter::format(string), __VA_ARGS__))
 
#define ASSIMP_LOG_VERBOSE_DEBUG_F(string, ...) \
    Assimp::DefaultLogger::get()->verboseDebug((Assimp::Formatter::format(string), __VA_ARGS__))
 
#define ASSIMP_LOG_INFO_F(string, ...) \
    Assimp::DefaultLogger::get()->info((Assimp::Formatter::format(string), __VA_ARGS__))
 
#define ASSIMP_LOG_WARN(string) \
    Assimp::DefaultLogger::get()->warn(string)
 
#define ASSIMP_LOG_ERROR(string) \
    Assimp::DefaultLogger::get()->error(string)
 
#define ASSIMP_LOG_DEBUG(string) \
    Assimp::DefaultLogger::get()->debug(string)
 
#define ASSIMP_LOG_VERBOSE_DEBUG(string) \
    Assimp::DefaultLogger::get()->verboseDebug(string)
 
#define ASSIMP_LOG_INFO(string) \
    Assimp::DefaultLogger::get()->info(string)
 
#endif // !! INCLUDED_AI_LOGGER_H