111 lines
3.5 KiB
C++
111 lines
3.5 KiB
C++
/**
|
|
* @author Edouard DUPIN
|
|
*
|
|
* @copyright 2011, Edouard DUPIN, all right reserved
|
|
*
|
|
* @license BSD v3 (see license file)
|
|
*/
|
|
|
|
#ifndef __ETK_LOG_H__
|
|
#define __ETK_LOG_H__
|
|
|
|
#include <etk/types.h>
|
|
#include <sstream>
|
|
#include <ostream>
|
|
#include <vector>
|
|
|
|
namespace etk {
|
|
namespace log {
|
|
/**
|
|
* @brief Log level is a simple list of all log availlable. This enum is used when setting a log and when user chose the level of log displayed.
|
|
*/
|
|
enum level {
|
|
logLevelNone = 0, //!< no display requested
|
|
logLevelCritical = 1, //!< Display only critical logs (note that critical generally assert with a backtrace (when we can))
|
|
logLevelError = 2, //!< Display Error and critical logs
|
|
logLevelWarning = 3, //!< Display log critical to warning
|
|
logLevelInfo = 4, //!< Display log critical to information (removed in release mode)
|
|
logLevelDebug = 5, //!< Display log critical to debug (removed in release mode)
|
|
logLevelVerbose = 6 //!< Display all logs (removed in release and debug mode)
|
|
};
|
|
/**
|
|
* @brief Register an element in the log system
|
|
* @param[in] _name Name of the module
|
|
* @return reference Id of an instance name
|
|
*/
|
|
int32_t registerInstance(const std::string& _name);
|
|
/**
|
|
* @brief Set the log level of a specific instance
|
|
* @param[in] _name Name of the intance
|
|
* @param[in] _id Id of the intance
|
|
* @param[in] _level New level to set on the instance
|
|
*/
|
|
void setLevel(const std::string& _name, enum level _level);
|
|
//! @previous
|
|
void setLevel(int32_t _id, enum level _level);
|
|
/**
|
|
* @brief Set global debug level
|
|
* @param[in] _level New level to set on the instance
|
|
*/
|
|
void setLevel(enum level _level);
|
|
/**
|
|
* @brief Get the current level of debug for a specific intance
|
|
* @param[in] _id Id Of the intance
|
|
* @return the enum casted in an integer ==> generise the API (not dependent of etk)
|
|
*/
|
|
int32_t getLevel(int32_t _id);
|
|
/**
|
|
* @brief Get list of all intance
|
|
* @return the name list of all intance
|
|
*/
|
|
std::vector<std::string> getListInstance();
|
|
/**
|
|
* @brief Set Color enable or disable.
|
|
* @param[in] _status New value of color.
|
|
*/
|
|
void setColor(bool _status);
|
|
/**
|
|
* @brief Set Time display enable or disable.
|
|
* @param[in] _status New value.
|
|
*/
|
|
void setTime(bool _status);
|
|
/**
|
|
* @brief Set Line display enable or disable.
|
|
* @param[in] _status New value.
|
|
*/
|
|
void setLine(bool _status);
|
|
/**
|
|
* @brief Set Function display enable or disable.
|
|
* @param[in] _status New value.
|
|
*/
|
|
void setFunction(bool _status);
|
|
/**
|
|
* @brief Call log to display
|
|
* @param[in] _id Id of the instance type
|
|
* @param[in] _level Level debug
|
|
* @param[in] _ligne Line of the debug
|
|
* @param[in] _className Class name of the debug
|
|
* @param[in] _funcName Function name for debug
|
|
* @param[in] _log Stream to log
|
|
*/
|
|
void logChar(int32_t _id, int32_t _level, int32_t _ligne, const char* _className, const char* _funcName, const char* _log);
|
|
//! @previous
|
|
void logStream(int32_t _id, int32_t _level, int32_t _ligne, const char* _className, const char* _funcName, const std::ostream& _log);
|
|
//! @previous
|
|
void logChar1(int32_t _id, int32_t _level, const char* _log);
|
|
//! @previous
|
|
void logStream1(int32_t _id, int32_t _level, const std::ostream& _log);
|
|
/**
|
|
* @brief Display the current backtrace
|
|
* @param[in] _breakAtEnd assert program when backtrace is printed
|
|
*/
|
|
void displayBacktrace(bool _breakAtEnd = false);
|
|
};
|
|
};
|
|
#ifdef __class__
|
|
#undef __class__
|
|
#endif
|
|
#define __class__ (NULL)
|
|
|
|
#endif
|