Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members

Notify Class Reference

An object that handles general error reporting to the user. More...

#include <notify.h>

List of all members.

Public Types

typedef bool AssertHandler (const char *expression, int line, const char *source_file)

Public Member Functions

Notify ()

~Notify ()

void set_ostream_ptr (ostream *ostream_ptr, bool delete_later)

Changes the ostream that all subsequent Notify messages will be written to.

ostream * get_ostream_ptr () const

Returns the system-wide ostream for all Notify messages.

void set_assert_handler (AssertHandler *assert_handler)

Sets a pointer to a C function that will be called when an assertion test fails.

void clear_assert_handler ()

Removes the installed assert handler and restores default behavior of nassertr() and nassertv().

bool has_assert_handler () const

Returns true if a user assert handler has been installed, false otherwise.

AssertHandler * get_assert_handler () const

Returns a pointer to the user-installed assert handler, if one was installed, or NULL otherwise.

bool has_assert_failed () const

Returns true if an assertion test has failed (and not been ignored) since the last call to clear_assert_failed().

const string & get_assert_error_message () const

Returns the error message that corresponds to the assertion that most recently failed.

void clear_assert_failed ()

Resets the assert_failed flag that is set whenever an assertion test fails.

NotifyCategory * get_top_category ()

Returns the topmost Category in the hierarchy.

NotifyCategory * get_category (const string &basename, NotifyCategory *parent_category)

Finds or creates a new Category given the basename of the category and its parent in the category hierarchy.

NotifyCategory * get_category (const string &basename, const string &parent_fullname)

Finds or creates a new Category given the basename of the category and the fullname of its parent.

NotifyCategory * get_category (const string &fullname)

Finds or creates a new Category given the fullname of the Category.

bool assert_failure (const char *expression, int line, const char *source_file)

This function is not intended to be called directly by user code.

void config_initialized ()

Intended to be called only by Config, this is a callback that indicated to Notify when Config has done initializing and Notify can safely set up some internal state variables that depend on Config variables.

Static Public Member Functions

ostream & out ()

A convenient way to get the ostream that should be written to for a Notify-type message.

ostream & null ()

A convenient way to get an ostream that doesn't do anything.

void write_string (const string &str)

A convenient way for scripting languages, which may know nothing about ostreams, to write to Notify.

Notify * ptr ()

Returns the pointer to the global Notify object.

ios_fmtflags get_literal_flag ()

Returns a flag that may be set on the Notify stream via setf() that, when set, enables "literal" mode, which means the Notify stream will not attempt to do any fancy formatting (like word-wrapping).

NotifySeverity string_severity (const string &string)

Given a string, one of "debug", "info", "warning", etc., return the corresponding Severity level, or NS_unspecified if none of the strings matches.

Private Types

typedef map< string, NotifyCategory * > Categories

Private Attributes

ostream * _ostream_ptr

bool _owns_ostream_ptr

ostream * _null_ostream_ptr

AssertHandler * _assert_handler

bool _assert_failed

string _assert_error_message

Categories _categories

Static Private Attributes

Notify * _global_ptr = (Notify *)NULL

Detailed Description

An object that handles general error reporting to the user.

It contains a pointer to an ostream, initially cerr, which can be reset at will to point to different output devices, according to the needs of the application. All output generated within Panda should vector through the Notify ostream.

This also includes a collection of Categories and Severities, which may be independently enabled or disabled, so that error messages may be squelched or respected according to the wishes of the user.

Definition at line 61 of file notify.h.

Member Typedef Documentation

typedef bool Notify::AssertHandler(const char *expression, int line, const char *source_file)

Definition at line 69 of file notify.h.
Referenced by Notify().

typedef map<string, NotifyCategory *> Notify::Categories [private]

Definition at line 112 of file notify.h.

Constructor & Destructor Documentation

Notify::Notify ( )

Definition at line 45 of file notify.cxx.
References _assert_failed, _assert_handler, AssertHandler, and NULL.

Notify::~Notify ( )

Definition at line 62 of file notify.cxx.
References _ostream_ptr, _owns_ostream_ptr, and NULL.

Member Function Documentation

bool Notify::assert_failure ( const char * expression,

int line,

const char * source_file

)

This function is not intended to be called directly by user code.
It's called from the nassertr() and assertv() macros when an assertion test fails; it handles the job of printing the warning message and deciding what to do about it.
If this function returns true, the calling function should return out of its function; if it returns false, the calling function should ignore the assertion.
Definition at line 554 of file notify.cxx.

void Notify::clear_assert_failed ( )

Resets the assert_failed flag that is set whenever an assertion test fails.
See has_assert_failed().
Definition at line 309 of file notify.cxx.
References _categories.

void Notify::clear_assert_handler ( )

Removes the installed assert handler and restores default behavior of nassertr() and nassertv().

Definition at line 206 of file notify.cxx.
References _assert_failed.

void Notify::config_initialized ( )

Intended to be called only by Config, this is a callback that indicated to Notify when Config has done initializing and Notify can safely set up some internal state variables that depend on Config variables.

Definition at line 656 of file notify.cxx.

const string & Notify::get_assert_error_message ( ) const

Returns the error message that corresponds to the assertion that most recently failed.

Definition at line 294 of file notify.cxx.
References get_category().

Notify::AssertHandler * Notify::get_assert_handler ( ) const

Returns a pointer to the user-installed assert handler, if one was installed, or NULL otherwise.

Definition at line 236 of file notify.cxx.
References get_category().

NotifyCategory * Notify::get_category ( const string & fullname )

Finds or creates a new Category given the fullname of the Category.
This name should be a sequence of colon-separated names of parent Categories, ending in the basename of this Category, e.g. display:glxdisplay. This is a shorthand way to define a Category when a pointer to its parent is not handy.
Definition at line 429 of file notify.cxx.
References nout.

NotifyCategory * Notify::get_category ( const string & basename,

const string & parent_fullname

)

Finds or creates a new Category given the basename of the category and the fullname of its parent.
This is another way to create a category when you don't have a pointer to its parent handy, but you know the name of its parent. If the parent Category does not already exist, it will be created.
Definition at line 404 of file notify.cxx.
References _assert_error_message, _assert_failed, has_assert_handler(), and ostringstream::str().

NotifyCategory * Notify::get_category ( const string & basename,

NotifyCategory * parent_category

)

Finds or creates a new Category given the basename of the category and its parent in the category hierarchy.
The parent pointer may be NULL to indicate this is a top-level Category.
Definition at line 346 of file notify.cxx.
References _ostream_ptr, and ptr().
Referenced by get_assert_error_message(), and get_assert_handler().

ios_fmtflags Notify::get_literal_flag ( ) [static]

Returns a flag that may be set on the Notify stream via setf() that, when set, enables "literal" mode, which means the Notify stream will not attempt to do any fancy formatting (like word-wrapping).
Notify does not itself respect this flag; this is left up to the ostream that Notify writes to. Note that Notify just maps to cerr by default, in which case this does nothing. But the flag is available in case any extended types want to make use of it.
Definition at line 142 of file notify.cxx.
References _assert_handler.

ostream * Notify::get_ostream_ptr ( ) const

Returns the system-wide ostream for all Notify messages.

Definition at line 111 of file notify.cxx.
References ios_fmtflags.

NotifyCategory * Notify::get_top_category ( )

Returns the topmost Category in the hierarchy.
This may be used to traverse the hierarchy of available Categories.
Definition at line 327 of file notify.cxx.
References NULL, and size_t.

bool Notify::has_assert_failed ( ) const

Returns true if an assertion test has failed (and not been ignored) since the last call to clear_assert_failed().
When an assertion test fails, the assert handler may decide either to abort, return, or ignore the assertion. Naturally, if it decides to abort, this flag is irrelevant. If it chooses to ignore the assertion, the flag is not set. However, if the assert handler chooses to return out of the function (the normal case), it will also set this flag to indicate that an assertion failure has occurred.
This will also be the behavior in the absence of a user-defined assert handler.
Definition at line 279 of file notify.cxx.

bool Notify::has_assert_handler ( ) const

Returns true if a user assert handler has been installed, false otherwise.

Definition at line 221 of file notify.cxx.
References _assert_failed.
Referenced by get_category().

ostream & Notify::null ( ) [static]

A convenient way to get an ostream that doesn't do anything.
Returned by Category::out() when a particular Category and/or Severity is disabled.
Definition at line 486 of file notify.cxx.

ostream & Notify::out ( ) [static]

A convenient way to get the ostream that should be written to for a Notify-type message.
Also see Category::out() for a message that is specific to a particular Category.
Definition at line 469 of file notify.cxx.
References NS_spam.
Referenced by ptr().

Notify * Notify::ptr ( ) [static]

Returns the pointer to the global Notify object.
There is only one of these in the world.
Definition at line 520 of file notify.cxx.
References nout, and out().
Referenced by get_category().

void Notify::set_assert_handler ( Notify::AssertHandler * assert_handler )

Sets a pointer to a C function that will be called when an assertion test fails.
This function may decide what to do when that happens: it may choose to abort or return. If it returns, it should return true to indicate that the assertion should be respected (and the calling function should return out of its block of code), or false to indicate that the assertion should be completely ignored.
If an assert handler is installed, it completely replaces the default behavior of nassertr() and nassertv().
Definition at line 191 of file notify.cxx.

void Notify::set_ostream_ptr ( ostream * ostream_ptr,

bool delete_later

)

Changes the ostream that all subsequent Notify messages will be written to.
If the previous ostream was set with delete_later = true, this will delete the previous ostream. If ostream_ptr is NULL, this resets the default to cerr.
Definition at line 86 of file notify.cxx.
References _ostream_ptr.

NotifySeverity Notify::string_severity ( const string & string ) [static]

Given a string, one of "debug", "info", "warning", etc., return the corresponding Severity level, or NS_unspecified if none of the strings matches.

Definition at line 606 of file notify.cxx.
Referenced by NotifyCategory::NotifyCategory().

void Notify::write_string ( const string & str ) [static]

A convenient way for scripting languages, which may know nothing about ostreams, to write to Notify.
This writes a single string, followed by an implicit newline, to the Notify output stream.
Definition at line 505 of file notify.cxx.

Member Data Documentation

string Notify::_assert_error_message [private]

Definition at line 110 of file notify.h.
Referenced by get_category().

bool Notify::_assert_failed [private]

Definition at line 109 of file notify.h.
Referenced by clear_assert_handler(), get_category(), has_assert_handler(), and Notify().

AssertHandler* Notify::_assert_handler [private]

Definition at line 108 of file notify.h.
Referenced by get_literal_flag(), and Notify().

Categories Notify::_categories [private]

Definition at line 113 of file notify.h.
Referenced by clear_assert_failed().

Notify * Notify::_global_ptr = (Notify *)NULL [static, private]

Definition at line 34 of file notify.cxx.

ostream* Notify::_null_ostream_ptr [private]

Definition at line 106 of file notify.h.

ostream* Notify::_ostream_ptr [private]

Definition at line 104 of file notify.h.
Referenced by get_category(), set_ostream_ptr(), and ~Notify().

bool Notify::_owns_ostream_ptr [private]

Definition at line 105 of file notify.h.
Referenced by ~Notify().

The documentation for this class was generated from the following files:

dtool/src/dconfig/notify.h
dtool/src/dconfig/notify.cxx

Generated on Thu May 1 22:13:40 2003 for DTool by

1.3


Public Types
typedef bool	AssertHandler (const char expression, int line, const char source_file)
Public Member Functions
	Notify ()
	~Notify ()
void	set_ostream_ptr (ostream *ostream_ptr, bool delete_later)
	Changes the ostream that all subsequent Notify messages will be written to.
ostream *	get_ostream_ptr () const
	Returns the system-wide ostream for all Notify messages.
void	set_assert_handler (AssertHandler *assert_handler)
	Sets a pointer to a C function that will be called when an assertion test fails.
void	clear_assert_handler ()
	Removes the installed assert handler and restores default behavior of nassertr() and nassertv().
bool	has_assert_handler () const
	Returns true if a user assert handler has been installed, false otherwise.
AssertHandler *	get_assert_handler () const
	Returns a pointer to the user-installed assert handler, if one was installed, or NULL otherwise.
bool	has_assert_failed () const
	Returns true if an assertion test has failed (and not been ignored) since the last call to clear_assert_failed().
const string &	get_assert_error_message () const
	Returns the error message that corresponds to the assertion that most recently failed.
void	clear_assert_failed ()
	Resets the assert_failed flag that is set whenever an assertion test fails.
NotifyCategory *	get_top_category ()
	Returns the topmost Category in the hierarchy.
NotifyCategory *	get_category (const string &basename, NotifyCategory *parent_category)
	Finds or creates a new Category given the basename of the category and its parent in the category hierarchy.
NotifyCategory *	get_category (const string &basename, const string &parent_fullname)
	Finds or creates a new Category given the basename of the category and the fullname of its parent.
NotifyCategory *	get_category (const string &fullname)
	Finds or creates a new Category given the fullname of the Category.
bool	assert_failure (const char expression, int line, const char source_file)
	This function is not intended to be called directly by user code.
void	config_initialized ()
	Intended to be called only by Config, this is a callback that indicated to Notify when Config has done initializing and Notify can safely set up some internal state variables that depend on Config variables.
Static Public Member Functions
ostream &	out ()
	A convenient way to get the ostream that should be written to for a Notify-type message.
ostream &	null ()
	A convenient way to get an ostream that doesn't do anything.
void	write_string (const string &str)
	A convenient way for scripting languages, which may know nothing about ostreams, to write to Notify.
Notify *	ptr ()
	Returns the pointer to the global Notify object.
ios_fmtflags	get_literal_flag ()
	Returns a flag that may be set on the Notify stream via setf() that, when set, enables "literal" mode, which means the Notify stream will not attempt to do any fancy formatting (like word-wrapping).
NotifySeverity	string_severity (const string &string)
	Given a string, one of "debug", "info", "warning", etc., return the corresponding Severity level, or NS_unspecified if none of the strings matches.
Private Types
typedef map< string, NotifyCategory * >	Categories
Private Attributes
ostream *	_ostream_ptr
bool	_owns_ostream_ptr
ostream *	_null_ostream_ptr
AssertHandler *	_assert_handler
bool	_assert_failed
string	_assert_error_message
Categories	_categories
Static Private Attributes
Notify *	_global_ptr = (Notify *)NULL