disti_assert.h

Go to the documentation of this file.

/*! \file
  \brief  Contains the DistiAssert macro.
 
  \par Copyright Information
 
  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd., Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>
 
  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.
 
  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
 
  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).
 
  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.
 
*/
#ifndef INCLUDED_DISTI_ASSERT_H
#define INCLUDED_DISTI_ASSERT_H
 
#include "disti_include.h"
#include "gls_cpp_lang_support.h"
#include <stddef.h>
 
namespace disti
{
class DistiException;
 
/// Swaps the incoming DistiException objects.
/// \param first The first object to swap.
/// \param second The other object to swap.
DISTI_EXPORT void swap( DistiException& first, DistiException& second );
 
/** DistiException just contains a string error message */
class DistiException
{
public:
    /// Construct a DistiException with the given error message.
    /// \param what The error message.
    explicit DISTI_EXPORT DistiException( const char* what );
 
    /// Copy constructor
    /// \param other The object to copy.
    DISTI_EXPORT DistiException( const DistiException& other );
 
    /// Assignment operator
    /// \param other The object value to assign.
    /// \return The new object.
    DISTI_EXPORT DistiException& operator=( DistiException other );
 
#ifdef DISTI_HAS_RVAL_REFS
    /// Move operator
    /// \param other The object to move.
    DISTI_EXPORT DistiException( DistiException&& other );
#endif
    virtual DISTI_EXPORT ~DistiException();
 
    /// \note Never returns NULL.
    /// \return The underlying error string.
    virtual DISTI_EXPORT const char* what() const;
 
    friend DISTI_EXPORT void swap( DistiException& first, DistiException& second );
 
private:
    char*  _what; ///< The error string.
    size_t _len;  ///< The length of the error string.
};
 
/** The callback type. It receives an error message string */
typedef void ( *DistiAssertHandler )( const char* errMessage );
 
/// This function enables users to override the default behavior of DistiAssert(), which is used
/// throughout the GL Studio code base to test prerequisites etc. The user can set a function to
/// be called when DistiAssert fires. Only one callback can be registered, so calling the set
/// function multiple times overwrites the previous handler. If the given handler is null,
/// DistiAssert() reverts to its default behavior.
/// \note This function is deprecated; Use SetGlsVerifyHandler or SetGlsAssertHandler instead.
DISTI_EXPORT void SetDistiAssertHandler( DistiAssertHandler );
 
/// This function enables users to override the default behavior of GLS_VERIFY(), which is used
/// throughout the GL Studio code base to test prerequisites etc. The user can set a function to
/// be called when GLS_VERIFY fires. Only one callback can be registered, so calling the set
/// function multiple times overwrites the previous handler. If the given handler is null,
/// GLS_VERIFY() reverts to its default behavior.
DISTI_EXPORT void SetGlsVerifyHandler( DistiAssertHandler );
 
/// This function enables users to override the default behavior of GLS_ASSERT(), which is used
/// throughout the GL Studio code base to test prerequisites etc. The user can set a function to
/// be called when GLS_ASSERT fires. Only one callback can be registered, so calling the set
/// function multiple times overwrites the previous handler. If the given handler is null,
/// GLS_ASSERT() reverts to its default behavior.
DISTI_EXPORT void SetGlsAssertHandler( DistiAssertHandler );
 
/// If a callback is registered, that function is invoked when an assertion fails (exp is false).
/// If the callback is null, when the assertion fails, DistiAssert will popup a messagebox allowing
/// the user to Abort, Retry(Debug) or Ignore the error. Retry will cause a User breakpoint on the
/// error, Abort will throw a DistiException describing the error, and Ignore does nothing.
/// At present, the function does the same thing in debug and release modes.
/// \note This function is deprecated; Use GLS_ASSERT or GLS_VERIFY instead.
#if defined( GLS_DEBUG )
#    define DistiAssert( exp ) (void)( ( exp ) || ( ::disti::DistiAssertDebug( #    exp, __FILE__, __LINE__ ), 0 ) )
#else
#    define DistiAssert( exp ) (void)( ( exp ) || ( ::disti::DistiAssertRelease( #    exp, __FILE__, __LINE__ ), 0 ) )
#endif
 
/// Convenience macro to quiet warnings about unused return values.
#define GLS_UNUSED( exp )    \
    do                       \
    {                        \
        (void)sizeof( exp ); \
    } while( 0 )
 
/** In builds where GLS_DEBUG is defined OR where NDEBUG is not defined, this macro has the following behavior:
  * 
  *   1. If a callback is registered with SetGlsAssertHandler(), that handler is invoked when an assertion
  *      fails (\a exp is false).
  *      
  *   2. If no handler is registered and the assertion fails, on Windows GLS_ASSERT will popup a message box
  *      allowing the user to Abort, Retry (Debug), or Ignore the error. Retry will cause a User breakpoint 
  *      on the error, Abort will throw a DistiException describing the error, and Ignore does nothing.
  *      
  * If none of the aforementioned symbols are defined, this function does nothing, and does not evaluate \a exp.
  *
  * \note Use this function instead of the deprecated DistiAssert() macro for checks that should be tested in
  *       Debug builds only.
  */
#if defined( GLS_DEBUG ) || !defined( NDEBUG )
#    define GLS_ASSERT( exp )                                                           \
        do                                                                              \
        {                                                                               \
            (void)( ( exp ) || ( ::disti::GlsAssert( #exp, __FILE__, __LINE__ ), 0 ) ); \
        } while( 0 )
#else
#    define GLS_ASSERT( exp ) GLS_UNUSED( exp )
#endif
 
/** The GLS_VERIFY() macro has the following behavior:
  * 
  *   1. If a callback is registered with SetGlsVerifyHandler(), that handler is invoked when \a exp is false.
  *      
  *   2. If no handler is registered and the \a exp is false, on Windows GLS_VERIFY() will popup a message box
  *      allowing the user to Abort, Retry (Debug), or Ignore the error. Retry will cause a User breakpoint 
  *      on the error, Abort will throw a DistiException describing the error, and Ignore does nothing.
  *
  * \note Use this function instead of the deprecated DistiAssert() macro for checks that should be tested in
  *       both Debug and Release builds.
  */
#define GLS_VERIFY( exp ) (void)( ( exp ) || ( ::disti::GlsVerify( #exp, __FILE__, __LINE__ ), 0 ) )
 
/// Do not call DistiAssertDebug directly, instead use the DistiAssert macro
/// \note This function is deprecated; Use GlsAssert or GlsVerify instead.
/// \param expression The string representation of the code being asserted.
/// \param filename The file where the code resides.
/// \param lineNumber The line number where the code resides.
DISTI_EXPORT void DistiAssertDebug( const char* expression, const char* filename, unsigned int lineNumber );
 
/// Do not call DistiAssertRelease directly, instead use the DistiAssert macro
/// \note This function is deprecated; Use GlsAssert or GlsVerify instead.
/// \param expression The string representation of the code being asserted.
/// \param filename The file where the code resides.
/// \param lineNumber The line number where the code resides.
DISTI_EXPORT void DistiAssertRelease( const char* expression, const char* filename, unsigned int lineNumber );
 
/// Do not call GlsVerify directly, instead use the GLS_VERIFY macro.
/// \param expression The string representation of the code being asserted.
/// \param filename The file where the code resides.
/// \param lineNumber The line number where the code resides.
DISTI_EXPORT void GlsVerify( const char* expression, const char* filename, unsigned int lineNumber );
 
/// Do not call GlsAssert directly, instead use the GLS_ASSERT macro.
/// \param expression The string representation of the code being asserted.
/// \param filename The file where the code resides.
/// \param lineNumber The line number where the code resides.
DISTI_EXPORT void GlsAssert( const char* expression, const char* filename, unsigned int lineNumber );
 
/// Assert the pointer is not null and return it.
/// \param p The pointer to check.
/// \return The pointer that was checked.
template<class T>
T* ValidatePointer( const T* const p )
{
    DistiAssert( p );
    return p;
}
 
} // namespace disti
 
#endif