X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FcreaMessageManager.h;h=37fe5bf1e65a0acdf678b97b1c9a73a0de4dfe22;hb=6046bb273fb32c833eb5d90aa8c856339a8d6df7;hp=0fe8110c12bf2a6fe2847a895fd7415a9df852f4;hpb=7c20ef5b6b9bcfe07f7b8e887360b70fc399962c;p=crea.git diff --git a/src/creaMessageManager.h b/src/creaMessageManager.h index 0fe8110..37fe5bf 100644 --- a/src/creaMessageManager.h +++ b/src/creaMessageManager.h @@ -1,376 +1,376 @@ - -/*! \file - - \brief Class creaMessageManager and Macros for outputing messages in crea - - There are 4 kinds of messages : - - Messages (normal messages) - - Debug messages (not compiled in release) - - Warnings - - Errors - There are also "types" of messages which are strings which identify the nature of the message - (for example : "Kernel" messages are generated by the core classes of the library, there can be a type of - message for each type of Node, and so on...) - A type of message must be declared by registering it into the MessageManager. This is done by a line like : - crea::MessageManager::RegisterMessageType("Kernel","Messages generated by the core classes of the library",5); - where : - -The first string is the type of the message (the category which will be used to generate a message of this type) - -The second string is help string - -The integer is the initial level for the messages of this type (see below). - - To generate a message of a known type then use one of the macros : - creaMessage, creaDebugMessage, creaWarning, creaError or their variants. - - example : - - creaMessage("Kernel",4,"problem with "< -#include -#include -#include - -// Comment out these symbols to prevent compilation -//#define CREA_COMPILE_MESSAGES -//#define CREA_COMPILE_DEBUG_MESSAGES -//#define CREA_COMPILE_WARNING_MESSAGES -//#define CREA_COMPILE_ERROR_MESSAGES - - -#define creaOnMessageLevel(key,value) \ - int __creaOnMessageLevelVariable = \ - crea::MessageManager::GetMessageLevel(key); \ - if ( __creaOnMessageLevelVariable<0) \ - { \ - creaWarning("message type '"<0) \ - { \ - std::cerr << "!! WARNING !! " << MESSAGE << std::endl; \ - if (lev >1) \ - { \ - std::cerr << "!! WARNING !! In file '"<<__FILE__ \ - <<"' ; Line "<<__LINE__< -#include - -namespace crea -{ - - class CREA_EXPORT MessageManager - { - public: - //============================================= - typedef boost::signal MessageSignalType; - typedef MessageSignalType::slot_function_type MessageCallbackType; - //============================================= - /// - MessageManager(); - /// - ~MessageManager(); - /// - static MessageManager* GetInstance(); - /// - static void RegisterMessageType(const std::string& key, - const std::string& help, - unsigned char default_level = 9); - /// - static void SetMessageLevel(const std::string& key, unsigned char level); - /// - static int GetMessageLevel(const std::string& key); - /// - static void SendMessage(const std::string& key, const std::string& mess); - /// - static void AddMessageObserver(const std::string& key, MessageCallbackType callback ); - /// - static void SendMessagesToCout(bool v = true); - /// - static std::string& GetTab() { static std::string s; return s; } - /// - static std::string GetSpace(int n) { - std::string s; s.insert(0," ",n); return s; } - /// - static void IncTab() { GetTab() += std::string(" "); } - /// - static void DecTab() { GetTab() = GetTab().substr(0,GetTab().length()-1); } - /// - static void ResetTab() { GetTab() = std::string(""); } - /// - static void PrintInfo(); - /// - - private: - struct MessageType - { - MessageType(int l, const std::string& h) : Level(l), Help(h) {} - int Level; - std::string Help; - MessageSignalType Signal; - }; - typedef std::map MessageMapType; - MessageMapType mMessageMap; - unsigned int mMaxMessageLength; - bool mSendToCout; - }; - //=========================================================== - -} - -#include "creaException.h" - -#endif + +/*! \file + + \brief Class creaMessageManager and Macros for outputing messages in crea + + There are 4 kinds of messages : + - Messages (normal messages) + - Debug messages (not compiled in release) + - Warnings + - Errors + There are also "types" of messages which are strings which identify the nature of the message + (for example : "Kernel" messages are generated by the core classes of the library, there can be a type of + message for each type of Node, and so on...) + A type of message must be declared by registering it into the MessageManager. This is done by a line like : + crea::MessageManager::RegisterMessageType("Kernel","Messages generated by the core classes of the library",5); + where : + -The first string is the type of the message (the category which will be used to generate a message of this type) + -The second string is help string + -The integer is the initial level for the messages of this type (see below). + + To generate a message of a known type then use one of the macros : + creaMessage, creaDebugMessage, creaWarning, creaError or their variants. + + example : + + creaMessage("Kernel",4,"problem with "< +#include + +#include +#include +#include +#include + +// Comment out these symbols to prevent compilation +//#define CREA_COMPILE_MESSAGES +//#define CREA_COMPILE_DEBUG_MESSAGES +//#define CREA_COMPILE_WARNING_MESSAGES +//#define CREA_COMPILE_ERROR_MESSAGES + + +#define creaOnMessageLevel(key,value) \ + int __creaOnMessageLevelVariable = \ + crea::MessageManager::GetMessageLevel(key); \ + if ( __creaOnMessageLevelVariable<0) \ + { \ + creaWarning("message type '"<0) \ + { \ + std::cerr << "!! WARNING !! " << MESSAGE << std::endl; \ + if (lev >1) \ + { \ + std::cerr << "!! WARNING !! In file '"<<__FILE__ \ + <<"' ; Line "<<__LINE__< MessageSignalType; + typedef MessageSignalType::slot_function_type MessageCallbackType; + //============================================= + /// + MessageManager(); + /// + ~MessageManager(); + /// + static MessageManager* GetInstance(); + /// + static void RegisterMessageType(const std::string& key, + const std::string& help, + unsigned char default_level = 9); + /// + static void SetMessageLevel(const std::string& key, unsigned char level); + /// + static int GetMessageLevel(const std::string& key); + /// + static void SendMessage(const std::string& key, const std::string& mess); + /// + static void AddMessageObserver(const std::string& key, MessageCallbackType callback ); + /// + static void SendMessagesToCout(bool v = true); + /// + static std::string& GetTab() { static std::string s; return s; } + /// + static std::string GetSpace(int n) { + std::string s; s.insert(0," ",n); return s; } + /// + static void IncTab() { GetTab() += std::string(" "); } + /// + static void DecTab() { GetTab() = GetTab().substr(0,GetTab().length()-1); } + /// + static void ResetTab() { GetTab() = std::string(""); } + /// + static void PrintInfo(); + /// + + private: + struct MessageType + { + MessageType(int l, const std::string& h) : Level(l), Help(h) {} + int Level; + std::string Help; + MessageSignalType Signal; + }; + typedef std::map MessageMapType; + MessageMapType mMessageMap; + unsigned int mMaxMessageLength; + bool mSendToCout; + }; + //=========================================================== + +} + +#include "creaException.h" + +#endif