Assert.hxx File Reference

Bug hunting and detection facilities for developers. More...

#include "Err.hxx"

Classes
class	CLAM::ErrAssertionFailed
	The exception thrown when an assertion fails. More...
Namespaces
namespace	CLAM
Defines
#define	CLAM_BREAKPOINT {}
	A macro containing break point assembler code for your platform.
#define	CLAM_USE_RELEASE_ASSERTS
#define	CLAM_ABORT(message)
	Macro used when an assert fails.
Assertions and checks

#define	CLAM_BEGIN_CHECK {
	Marks the start of check code block that is tied to a CLAM_ASSERT and can be removed without affecting any functionality.
#define	CLAM_END_CHECK }
	Ends a block of code started by CLAM_BEGIN_CHECK.
#define	CLAM_ASSERT(expression, message)
	An assertion is a check on an expression that must be true given that all the contracts are fullfilled.
#define	CLAM_WARNING(expression, message)
#define	CLAM_BEGIN_DEBUG_CHECK {
	Is the same that CLAM_BEGIN_CHECK but for a CLAM_DEBUG_ASSERT instead of a CLAM_ASSERT.
#define	CLAM_END_DEBUG_CHECK }
	Ends a block of code started by CLAM_BEGIN_DEBUG_CHECK.
#define	CLAM_DEBUG_ASSERT(expression, message)
#define	CLAM_DEBUG_WARNING(expression, message)
Typedefs
typedef void(*	CLAM::AssertFailedHandlerType )(const char message, const char filename, int lineNumber)
	The type of the asserts handlers.
typedef void(*	CLAM::WarningHandlerType )(const char message, const char filename, int lineNumber)
	The type of the warning handlers.
Functions
AssertFailedHandlerType	CLAM::SetAssertFailedHandler (AssertFailedHandlerType handler)
	Change the handler function called when an assertion fails.
void	CLAM::ExecuteAssertFailedHandler (const char message, const char filename, int linenumber)
	(Don't use directly, use the CLAM_ASSERT macro instead) Execute the assert failed handler.
WarningHandlerType	CLAM::SetWarningHandler (WarningHandlerType handler)
	Change the handler function called when a warning is given.
void	CLAM::ExecuteWarningHandler (const char message, const char filename, int linenumber)
	(Don't use directly, use the CLAM_WARNING macro instead) Execute the assert failed handler.

Detailed Description

Bug hunting and detection facilities for developers.

Definition in file Assert.hxx.

Define Documentation

#define CLAM_ABORT ( message )

Value:

do { \
                if ( !CLAM::ErrAssertionFailed::breakpointInCLAMAssertEnabled ) { \
                        throw CLAM::ErrAssertionFailed( message, __FILE__, __LINE__); \
                } else { \
                        CLAM::ExecuteAssertFailedHandler ( message, __FILE__, __LINE__); \
                        CLAM_BREAKPOINT; \
                } \
        } while(0)

Macro used when an assert fails.

Definition at line 80 of file Assert.hxx.

#define CLAM_ASSERT	(	expression,
		message		)

Value:

do { \
        if (!(expression)) { \
                CLAM_ABORT(message); \
        } } while (0)

An assertion is a check on an expression that must be true given that all the contracts are fullfilled.

Notice that this is NOT a regular (documented) check that will throw a (documented) error condition (Err). Asserts on debug mode (when the DEBUG macro is defined) will set a break point while in release mode (DEBUG is not defined) you may get an unexpected exception that can be catched by the application on the top level and do some backups actions. Any way, a descriptive message is displayed.

Sometimes the check is not only an expression but a complete set of statements. In these cases, you can use CLAM_BEGIN_CHECK and CLAM_END_CHECK macros to enclose the whole check code and use CLAM_ASSERT for concrete expressions to check.

You can change the default release mode assertion failed callback by using the SetAssertFailedHandler function.

You can get a lightweight assertion using (with care) the CLAM_DEBUG_ASSERT that is ignored on debug mode. By using the CLAM_DEBUG_ASSERT macro, the final application will not have the possibility of doing an honrous exit (backup data, bug log...) Is worth to keep most of the asserts as CLAM_ASSERT.

Anyway, for very performance depending applications you may use the CLAM_DISABLE_CHECKS to remove ALL the CLAM_ASSERT and CLAM_DEBUG_ASSERT and its related checks in whatever mode you use them.

Parameters:

	expression	The expression that must be true.
	message	A message that describes the unexpected runtime error to the programmer.

Definition at line 153 of file Assert.hxx.

#define CLAM_BEGIN_CHECK {

Marks the start of check code block that is tied to a CLAM_ASSERT and can be removed without affecting any functionality.

You must use it on the same sense that CLAM_ASSERT is used.

See also:: CLAM_ASSERT; CLAM_END_CHECK

Definition at line 151 of file Assert.hxx.

Referenced by CLAM::BasicXMLable::BasicXMLable(), CLAM::Spectrum::GetBPFSize(), and CLAM::Spectrum::GetSize().

#define CLAM_BEGIN_DEBUG_CHECK {

Is the same that CLAM_BEGIN_CHECK but for a CLAM_DEBUG_ASSERT instead of a CLAM_ASSERT.

See also:: CLAM_DEBUG_ASSERT; CLAM_BEGIN_CHECK; CLAM_END_DEBUG_CHECK

Definition at line 186 of file Assert.hxx.

Referenced by CLAM::Processing::AbleToExecute(), and CLAM::Enum::SetValue().

#define CLAM_BREAKPOINT {}

A macro containing break point assembler code for your platform.

If you platform is not being considered by the header you will get an warning message when compiling.

Definition at line 64 of file Assert.hxx.

#define CLAM_DEBUG_ASSERT	(	expression,
		message		)

Value:

do { \
                if (!(expression)) { \
                        CLAM_ABORT(message); \
                } } while (0)

Definition at line 188 of file Assert.hxx.

Referenced by CLAM::Processing::AbleToExecute(), CLAM::List< T >::AddElem(), CLAM::Fundamental::AddElem(), CLAM::WritingRegion< Token, DataStructure >::CanProduce(), CLAM::MIDIManager::Check(), CLAM::OutPortPublisher< Spectrum >::ConnectToIn(), CLAM::ReadingRegion< WritingRegion >::Consume(), CLAM::List< Frame >::Current(), CLAM::List< T >::DeleteElem(), CLAM::Fundamental::DeleteElem(), CLAM::InPortBase::Disconnect(), CLAM::OutPortPublisher< Spectrum >::DisconnectFromAll(), CLAM::OutPort< Token >::DisconnectFromConcreteIn(), CLAM::SynthSineSpectrum::Do(), CLAM::SpectrumInterpolator::Do(), CLAM::SpectrumAdder2::Do(), CLAM::SpectralPeakArrayInterpolator::Do(), CLAM::SpectralPeakArrayAdder::Do(), CLAM::SMSAnalysisCore::Do(), CLAM::Segmentator::Do(), CLAM::IFFT_ooura::Do(), CLAM::FrameInterpolator::Do(), CLAM::FrameAdder::Do(), CLAM::FFT_ooura::Do(), CLAM::List< T >::Extract(), CLAM::List< Frame >::First(), CLAM::Fundamental::GetErr(), CLAM::Fundamental::GetFreq(), CLAM::OutPort< Token >::GetLastWrittenData(), CLAM::DynamicType::InformAll(), CLAM::List< T >::InsertElem(), CLAM::Fundamental::InsertElem(), CLAM::List< Frame >::Last(), CLAM::List< Frame >::List(), CLAM::AudioCodecs::PCMAudioStream::MemoryToDiskTransfer(), CLAM::StreamImpl< Token, PhantomBuffer >::NewReadingRegionSize(), CLAM::StreamImpl< Token, PhantomBuffer >::NewWritingRegionSize(), CLAM::TabFunct< OriginalFunction >::operator()(), CLAM::CentralMoment< 4, abs, TData, TData >::operator()(), CLAM::WritingRegion< Token, DataStructure >::operator[](), CLAM::StreamImpl< Token, PhantomBuffer >::operator[](), CLAM::StreamImpl< Token, DataStructure >::operator[](), CLAM::ReadingRegion< WritingRegion >::operator[](), CLAM::List< T >::operator[](), CLAM::Array< TGuide >::operator[](), CLAM::WritingRegion< Token, DataStructure >::Produce(), CLAM::PhantomBuffer< T >::Read(), CLAM::Array< TGuide >::SetElem(), CLAM::Fundamental::SetErr(), CLAM::Fundamental::SetFreq(), CLAM::WindowGenerator::SetSize(), CLAM::PhantomBuffer< T >::Touch(), CLAM::InPort< Token >::UnAttachRegion(), and CLAM::PhantomBuffer< T >::Write().

#define CLAM_DEBUG_WARNING	(	expression,
		message		)

Value:

do { \
                if (!(expression)) { \
                        CLAM::ExecuteWarningHandler ( message, __FILE__, __LINE__); \
                } } while (0)

Definition at line 193 of file Assert.hxx.

#define CLAM_END_CHECK }

Ends a block of code started by CLAM_BEGIN_CHECK.

See also:: CLAM_BEGIN_CHECK

Definition at line 152 of file Assert.hxx.

Referenced by CLAM::BasicXMLable::BasicXMLable(), CLAM::Spectrum::GetBPFSize(), and CLAM::Spectrum::GetSize().

#define CLAM_END_DEBUG_CHECK }

Ends a block of code started by CLAM_BEGIN_DEBUG_CHECK.

See also:: CLAM_BEGIN_DEBUG_CHECK

Definition at line 187 of file Assert.hxx.

Referenced by CLAM::Processing::AbleToExecute(), and CLAM::Enum::SetValue().

#define CLAM_USE_RELEASE_ASSERTS

Definition at line 69 of file Assert.hxx.

#define CLAM_WARNING	(	expression,
		message		)

Value:

do { \
        if (!(expression)) { \
                CLAM::ExecuteWarningHandler ( message, __FILE__, __LINE__); \
        } } while (0)

Definition at line 158 of file Assert.hxx.

Referenced by CLAM::XmlStorage::AppendToDocument(), CLAM::Audio::SetDuration(), and CLAM::Audio::SetEndTime().

Assert.hxx File Reference

Classes

Namespaces

Defines

Typedefs

Functions

Detailed Description

Define Documentation