#include <MsgHandler.h>

Public Types
enum	MsgType { MT_MESSAGE, MT_WARNING, MT_ERROR }
Public Member Functions
void	addRetriever (OutputDevice *retriever)
	Adds a further retriever to the instance responsible for a certain msg type.
void	beginProcessMsg (std::string msg, bool addType=true)
	Begins a process information.
void	clear ()
	Clears information whether an error occured previously.
void	endProcessMsg (std::string msg)
	Ends a process information.
void	inform (std::string msg, bool addType=true)
	adds a new error to the list
template<class T >
MsgHandler &	operator<< (const T &t)
	Generic output operator.
void	progressMsg (std::string msg, bool addType=true)
	Writes a progress message.
void	removeRetriever (OutputDevice *retriever)
	Removes the retriever from the.
void	report2cerr (bool value)
	Sets the information whether stderr shall be used as output device.
void	report2cout (bool value)
	Sets the information whether stdout shall be used as output device.
bool	wasInformed () const
	Returns the information whether any messages were added.
Static Public Member Functions
static void	assignLock (AbstractMutex *lock)
	Sets the lock to use The lock will not be deleted.
static void	cleanupOnEnd ()
	Removes pending handler.
static MsgHandler *	getErrorInstance ()
	Returns the instance to add errors to.
static MsgHandler *	getMessageInstance ()
	Returns the instance to add normal messages to.
static MsgHandler *	getWarningInstance ()
	Returns the instance to add warnings to.
static void	initOutputOptions (bool gui=false)
Protected Member Functions
std::string	build (const std::string &msg, bool addType)
	Builds the string which includes the mml-message type.
Private Types
typedef std::vector < OutputDevice * >	RetrieverVector
	Definition of the list of retrievers to inform.
Private Member Functions
	MsgHandler (MsgType type)
	standard constructor
	MsgHandler (const MsgHandler &s)
MsgHandler &	operator= (const MsgHandler &s)
	~MsgHandler ()
	destructor
Private Attributes
bool	myReport2CERR
	Information whether stderr shall be used as output device, too.
bool	myReport2COUT
	Information whether stdout shall be used as output device, too.
RetrieverVector	myRetrievers
	The list of retrievers that shall be informed about new messages or errors.
MsgType	myType
	The type of the instance.
bool	myWasInformed
	information wehther an error occured at all
Static Private Attributes
static bool	myAmProcessingProcess = false
	Information whether a process information is printed to cout.
static MsgHandler *	myErrorInstance = 0
	The instance to handle errors.
static AbstractMutex *	myLock = 0
	The lock if any has to be used The lock will not be deleted.
static MsgHandler *	myMessageInstance = 0
	The instance to handle normal messages.
static MsgHandler *	myWarningInstance = 0
	The instance to handle warnings.

Detailed Description

MsgHandler

Definition at line 59 of file MsgHandler.h.

Member Typedef Documentation

typedef std::vector<OutputDevice*> MsgHandler::RetrieverVector [private]

Definition of the list of retrievers to inform.

Definition at line 210 of file MsgHandler.h.

Member Enumeration Documentation

enum MsgHandler::MsgType

An enumeration to differ between different types of messages (errors, warning and information)

Enumerator:

MT_MESSAGE	The message is only something to show.
MT_WARNING	The message is a warning.
MT_ERROR	The message is an error.

Definition at line 66 of file MsgHandler.h.

Constructor & Destructor Documentation

MsgHandler::MsgHandler ( MsgType type ) [private]

standard constructor

Definition at line 367 of file MsgHandler.cpp.

Referenced by getErrorInstance(), getMessageInstance(), and getWarningInstance().

MsgHandler::~MsgHandler ( ) [private]

destructor

Definition at line 372 of file MsgHandler.cpp.

MsgHandler::MsgHandler ( const MsgHandler & s ) [private]

invalid copy constructor

Member Function Documentation

void MsgHandler::addRetriever ( OutputDevice * retriever )

Adds a further retriever to the instance responsible for a certain msg type.

Definition at line 227 of file MsgHandler.cpp.

References OptionsCont::exists(), OptionsCont::getBool(), OptionsCont::getOptions(), AbstractMutex::lock(), MT_MESSAGE, MT_WARNING, myLock, myRetrievers, myType, and AbstractMutex::unlock().

Referenced by GUILoadThread::GUILoadThread(), GUIRunThread::init(), initOutputOptions(), and GUILoadThread::run().

void MsgHandler::assignLock ( AbstractMutex * lock ) [static]

Sets the lock to use The lock will not be deleted.

Definition at line 383 of file MsgHandler.cpp.

References myLock.

Referenced by main().

void MsgHandler::beginProcessMsg	(	std::string	msg,
		bool	addType = `true`
	)

Begins a process information.

When a longer action is started, this method should be used to inform the user about it. There will be no newline printed, but the message handler will be informed that a process message has been begun. If an error occurs, a newline will be printed. After the action has been performed, use endProcessMsg to inform the user about it.

Definition at line 158 of file MsgHandler.cpp.

References build(), AbstractMutex::lock(), myAmProcessingProcess, myLock, myReport2CERR, myReport2COUT, myRetrievers, myWasInformed, and AbstractMutex::unlock().