X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FcreaMessageManager.h;h=54dd93efcc954ff73cb1f9b7b81cf5397b4809b1;hb=b4cd33464fc8cc5658da64fe75c3f689169f0cb0;hp=87fb5f887c9773b5120c2ec75cb8f213de3ef58e;hpb=3048dcadbc42fcf6679edc959484ecd4b948eb9c;p=crea.git diff --git a/src/creaMessageManager.h b/src/creaMessageManager.h index 87fb5f8..54dd93e 100644 --- a/src/creaMessageManager.h +++ b/src/creaMessageManager.h @@ -1,149 +1,138 @@ - +/* +# --------------------------------------------------------------------- +# +# Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image +# pour la Santé) +# Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton +# Previous Authors : Laurent Guigues, Jean-Pierre Roux +# CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil +# +# This software is governed by the CeCILL-B license under French law and +# abiding by the rules of distribution of free software. You can use, +# modify and/ or redistribute the software under the terms of the CeCILL-B +# license as circulated by CEA, CNRS and INRIA at the following URL +# http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html +# or in the file LICENSE.txt. +# +# As a counterpart to the access to the source code and rights to copy, +# modify and redistribute granted by the license, users are provided only +# with a limited warranty and the software's author, the holder of the +# economic rights, and the successive licensors have only limited +# liability. +# +# The fact that you are presently reading this means that you have had +# knowledge of the CeCILL-B license and that you accept its terms. +# ------------------------------------------------------------------------ +*/ /*! \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 - #include -// Comment out these symbols to prevent compilation - -//#define CREA_COMPILE_MESSAGES +namespace crea +{ + class CREA_EXPORT MessageManager + { + public: + //============================================= + typedef boost::signals2::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 HSendMessage(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; + }; + //=========================================================== +} -//#define CREA_COMPILE_DEBUG_MESSAGES -//#define CREA_COMPILE_WARNING_MESSAGES -//#define CREA_COMPILE_ERROR_MESSAGES +// 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); \ @@ -153,8 +142,6 @@ } \ else if (value<= __creaOnMessageLevelVariable) - - #ifdef CREA_PREPEND_MESSAGE_WITH_CODE #define creaMessageCode \ key[0] << key[1] << key[2] << value << " " @@ -162,8 +149,6 @@ #define creaMessageCode "" #endif - - #ifdef CREA_PREPEND_MESSAGE_WITH_TAB #define creaMessageTab \ crea::MessageManager::GetTab() @@ -171,8 +156,6 @@ #define creaMessageTab "" #endif - - //#define CREA_PREPEND_MESSAGE_WITH_SPACE #ifdef CREA_PREPEND_MESSAGE_WITH_SPACE #define creaMessageSpace(value) \ @@ -199,7 +182,7 @@ << creaMessageTab \ << creaMessageSpace(value) \ << MESSAGE; \ - crea::MessageManager::SendMessage(key,s.str()); \ + crea::MessageManager::HSendMessage(key,s.str()); \ } \ } \ while (0) @@ -215,7 +198,7 @@ { \ std::ostringstream s; \ s << MESSAGE; \ - crea::MessageManager::SendMessage(key,s.str()); \ + crea::MessageManager::HSendMessage(key,s.str()); \ } \ } \ while (0) @@ -229,7 +212,7 @@ << creaMessageTab \ << creaMessageSpace(value) \ << MESSAGE; \ - crea::MessageManager::SendMessage(key,s.str()); \ + crea::MessageManager::HSendMessage(key,s.str()); \ crea::MessageManager::IncTab(); \ } \ } \ @@ -247,7 +230,7 @@ << creaMessageTab \ << creaMessageSpace(value) \ << MESSAGE; \ - crea::MessageManager::SendMessage(key,s.str()); \ + crea::MessageManager::HSendMessage(key,s.str()); \ } \ } \ while (0) @@ -444,127 +427,6 @@ -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; - - }; - - //=========================================================== - - - -}