gls_assert.h

Go to the documentation of this file.

/*! \file gls_assert.h

\brief  This header defines the runtime assert checking macros for
        the GL Studio DO-178B Runtime Library.

\par Copyright Information
Copyright (C) 1999-2012 The DiSTI Corporation<br>
Orlando, FL USA<br>
All rights reserved.<br>

  This file is copyrighted software and contains proprietary trade secrets of
DiSTI, and embodies substantial creative efforts as well as confidential
information, ideas, and expressions.

  Permission to use, and copy this software and its documentation for any
purpose is hereby granted per the Distribution Agreement and/or the Licensing
Agreement signed with DiSTI. This permission is granted provided that:
    1.  The above copyright notice appears in all copies.
    2.  That both the copyright notice and this permission notice appear in
        the supporting documentation.
    3.  That the names DiSTI and GL Studio not be used in advertising or
        publicity pertaining to distribution of the software without specific,
        written prior permission of DiSTI.
 
  Permission to modify the software is granted, but not the right to
distribute the source code whether modified, or non-modified.  Modifying the
software might invalidate the DO-178B certification package.

  Permission to distribute binaries produced by compiling source code, or
modified source code is granted, provided you:
    1.  Provide your name and address as the primary contact for the support
        of your modified version.
    2.  Retain our contact information in regard to use of the base software. 

   DiSTI does not provide warranty for this software or guarantee that it
satisfies any specification or requirement unless otherwise stated in a
specific contractual arrangement between the customer and DiSTI.

*/
#ifndef _GLS_ASSERT_H
#define _GLS_ASSERT_H

#include "gls_include.h"

#if defined( GLS_DEBUG ) && defined( GLS_UNIT_TEST )
#pragma BullseyeCoverage save off
#include <exception>
#include <sstream>
/** This class is used to report library assertion failures when running unit tests
  * in debug mode. ( GLS_DEBUG && GLS_UNIT_TEST )
  */
class GlsAssertionFailure : public std::exception
{
public:
    /** Constructor - create an instance with the given attributes
      * \param msg string message describing the assertion failure
      * \pre none 
      * \post GlsAssert macro is disabled
      */
    GlsAssertionFailure( const char* const msg ) :
        std::exception( msg )
    {
        // disable further GlsAssert s from throwing
        _glsAssertIsEnabled = false;
    }

    /** Dtor
      * \pre none
      * \post the GlsAssert macro is reenabled
      */
    ~GlsAssertionFailure() { _glsAssertIsEnabled = true; }

    /**  Determine if the GlsAssert macro should throw a GlsAssertionFailure in the debug unit test
      * build. GlsAssert is disabled after the first assertion failure so that further potential
      * assertion failures are not thrown as the stack unwinds.  One assertion failure stops the
      * unit test immediately so further assertion failures do not need to be thrown. The GlsAssert
      * macro is reenabled by the destructor for this class which is called once the assertion has
      * been caught and handled by the unit test runner.
      * \pre none
      * \post none
      * \return true if the GlsAssert macro should throw a GlsAssertionFailure else false
      */
    static bool GlsAssertIsEnabled( void ) { return( _glsAssertIsEnabled ); }

protected:
    static bool _glsAssertIsEnabled; /**< true if the GlsAssert macro should throw
                                       * a GlsAssertionFailure else false */
};
#pragma BullseyeCoverage restore
#endif // ( GLS_DEBUG && GLS_UNIT_TEST )

#if defined( GLS_DEBUG )
    #if defined( GLS_UNIT_TEST )
        // define GlsAssert macro to throw a GlsAssertionFailure when running unit tests in debug mode
        #define GlsAssert( _exp )   if( !( _exp ) && GlsAssertionFailure::GlsAssertIsEnabled() )                 \
                                    {                                                                            \
                                        std::ostringstream msg;                                                  \
                                        msg << "( " << #_exp << " ) at " << __FILE__ << " (" << __LINE__ << ")"; \
                                        throw( GlsAssertionFailure( msg.str().c_str() ) );                       \
                                    }
    #else 
        // define GlsAssert macro to use assert() if in debug mode and not unit test mode
        #include <assert.h>
        #define GlsAssert( _exp )   assert( _exp )
    #endif // GLS_UNIT_TEST
#else
    // define GlsAssert macro as empty if not in debug mode
    #define GlsAssert( _exp )   
#endif // defined( GLS_DEBUG )

#define GlsError()  GlsAssert( false )

#endif // _GLS_ASSERT_H