include/EDoc/NotificationIFace.h File Reference

#include "EDoc/stdint.h"
#include "EDoc/exceptions.h"
#include "EDoc/utils.h"
#include <string>
#include <map>
#include <list>
#include "EDoc/events.inc"

Go to the source code of this file.

Namespaces
namespace	EDoc
Data Structures
class	EDoc::NotificationIFace
	Notifies user of errors/warnings. More...
Defines
#define	EDOC_EVENT_ITEM(Type, Name, Description)   Name,
#define	EDOC_NOTIFICATION(Code, Message, IdFunction, IDFile, IdLine, IDRFile, IdRLine, IdType, IdPropogatingException, IdFunctionType, Extra)
	Macro used to generate notification events.
Typedefs
typedef uint32_t	EDoc::EventCode
Enumerations
enum	EDoc::EventType { EDoc::EVENT_ERROR, EDoc::EVENT_WARNING }
	Enumerates the event types that exist. More...
enum	EDoc::Events {   EDoc::Type, EDoc::Name, EDoc::ENOT_THROW, EDoc::WDIFF_THROW,   EDoc::WDIFF_IMPL, EDoc::WUNUSED_CATCH, EDoc::WSET_UNEXPECTED, EDoc::EV_UNDEFINED }
	Define the standard set of errors and warnings used by EDoc. More...
Functions
NotificationIFace *	EDoc::GetGlobalNotifier ()
	Returns a reference to the global notifier.
NotificationIFace *	EDoc::GetGlobalNotifierAssert ()
	Returns a reference to the global notifier or throws a BugException if it is not set.
void	EDoc::SetGlobalNotifier (NotificationIFace *gn)
	Sets the global notifier.

---

Define Documentation

#define EDOC_EVENT_ITEM	(	Type,
		Name,
		Description		)	Name,

#define EDOC_NOTIFICATION	(	Code,
		Message,
		IdFunction,
		IDFile,
		IdLine,
		IDRFile,
		IdRLine,
		IdType,
		IdPropogatingException,
		IdFunctionType,
		Extra		)

Value:

{ \
   std::ostringstream stream_kjhgbvk791; \
   stream_kjhgbvk791 << Message; \
   ::EDoc::GetGlobalNotifierAssert()->Event((::EDoc::EventCode)Code, \
      __FILE__, __LINE__, \
      stream_kjhgbvk791.str(), IdFunction, IDFile, IdLine, IDRFile, IdRLine, \
      IdType, IdPropogatingException, IdFunctionType, Extra); \
}

Macro used to generate notification events.

This should be used instead of calling NotificationIFace::Event() directly.

Definition at line 228 of file NotificationIFace.h.

Referenced by EDoc::FunctionType::Merge(), EDoc::Function::Merge(), EDoc::Dictionary::ProcessCodeBlock(), and EDoc::Dictionary::ProcessTryBlock().

---