Blame Iex/IexMacros.h

Packit 8dc392
///////////////////////////////////////////////////////////////////////////
Packit 8dc392
//
Packit 8dc392
// Copyright (c) 2002-2012, Industrial Light & Magic, a division of Lucas
Packit 8dc392
// Digital Ltd. LLC
Packit 8dc392
// 
Packit 8dc392
// All rights reserved.
Packit 8dc392
// 
Packit 8dc392
// Redistribution and use in source and binary forms, with or without
Packit 8dc392
// modification, are permitted provided that the following conditions are
Packit 8dc392
// met:
Packit 8dc392
// *       Redistributions of source code must retain the above copyright
Packit 8dc392
// notice, this list of conditions and the following disclaimer.
Packit 8dc392
// *       Redistributions in binary form must reproduce the above
Packit 8dc392
// copyright notice, this list of conditions and the following disclaimer
Packit 8dc392
// in the documentation and/or other materials provided with the
Packit 8dc392
// distribution.
Packit 8dc392
// *       Neither the name of Industrial Light & Magic nor the names of
Packit 8dc392
// its contributors may be used to endorse or promote products derived
Packit 8dc392
// from this software without specific prior written permission. 
Packit 8dc392
// 
Packit 8dc392
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Packit 8dc392
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Packit 8dc392
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Packit 8dc392
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Packit 8dc392
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Packit 8dc392
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Packit 8dc392
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Packit 8dc392
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Packit 8dc392
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Packit 8dc392
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Packit 8dc392
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Packit 8dc392
//
Packit 8dc392
///////////////////////////////////////////////////////////////////////////
Packit 8dc392
Packit 8dc392
Packit 8dc392
Packit 8dc392
#ifndef INCLUDED_IEXMACROS_H
Packit 8dc392
#define INCLUDED_IEXMACROS_H
Packit 8dc392
Packit 8dc392
//--------------------------------------------------------------------
Packit 8dc392
//
Packit 8dc392
//	Macros which make throwing exceptions more convenient
Packit 8dc392
//
Packit 8dc392
//--------------------------------------------------------------------
Packit 8dc392
Packit 8dc392
#include <sstream>
Packit 8dc392
Packit 8dc392
Packit 8dc392
//----------------------------------------------------------------------------
Packit 8dc392
// A macro to throw exceptions whose text is assembled using stringstreams.
Packit 8dc392
//
Packit 8dc392
// Example:
Packit 8dc392
//
Packit 8dc392
//	THROW (InputExc, "Syntax error in line " << line ", " << file << ".");
Packit 8dc392
//	
Packit 8dc392
//----------------------------------------------------------------------------
Packit 8dc392
Packit 8dc392
#include "IexExport.h"
Packit 8dc392
#include "IexForward.h"
Packit 8dc392
Packit 8dc392
IEX_EXPORT void iex_debugTrap();
Packit 8dc392
Packit 8dc392
#define THROW(type, text)       \
Packit 8dc392
    do                          \
Packit 8dc392
    {                           \
Packit 8dc392
        iex_debugTrap();        \
Packit 8dc392
        std::stringstream s;	\
Packit 8dc392
        s << text;              \
Packit 8dc392
        throw type (s);         \
Packit 8dc392
    }                           \
Packit 8dc392
    while (0)
Packit 8dc392
Packit 8dc392
Packit 8dc392
//----------------------------------------------------------------------------
Packit 8dc392
// Macros to add to or to replace the text of an exception.
Packit 8dc392
// The new text is assembled using stringstreams.
Packit 8dc392
//
Packit 8dc392
// Examples:
Packit 8dc392
//
Packit 8dc392
// Append to end of an exception's text:
Packit 8dc392
//
Packit 8dc392
//	catch (BaseExc &e)
Packit 8dc392
//	{
Packit 8dc392
//	    APPEND_EXC (e, " Directory " << name << " does not exist.");
Packit 8dc392
//	    throw;
Packit 8dc392
//	}
Packit 8dc392
//
Packit 8dc392
// Replace an exception's text:
Packit 8dc392
//
Packit 8dc392
//	catch (BaseExc &e)
Packit 8dc392
//	{
Packit 8dc392
//	    REPLACE_EXC (e, "Directory " << name << " does not exist. " << e);
Packit 8dc392
//	    throw;
Packit 8dc392
//	}
Packit 8dc392
//----------------------------------------------------------------------------
Packit 8dc392
Packit 8dc392
#define APPEND_EXC(exc, text)   \
Packit 8dc392
    do                          \
Packit 8dc392
    {                           \
Packit 8dc392
        std::stringstream s;    \
Packit 8dc392
        s << text;              \
Packit 8dc392
        exc.append (s);         \
Packit 8dc392
    }                           \
Packit 8dc392
    while (0)
Packit 8dc392
Packit 8dc392
#define REPLACE_EXC(exc, text)  \
Packit 8dc392
    do                          \
Packit 8dc392
    {                           \
Packit 8dc392
        std::stringstream s;    \
Packit 8dc392
        s << text;              \
Packit 8dc392
        exc.assign (s);         \
Packit 8dc392
    }                           \
Packit 8dc392
    while (0)
Packit 8dc392
Packit 8dc392
Packit 8dc392
//-------------------------------------------------------------
Packit 8dc392
// A macro to throw ErrnoExc exceptions whose text is assembled
Packit 8dc392
// using stringstreams:
Packit 8dc392
//
Packit 8dc392
// Example:
Packit 8dc392
//
Packit 8dc392
//	THROW_ERRNO ("Cannot open file " << name << " (%T).");
Packit 8dc392
//
Packit 8dc392
//-------------------------------------------------------------
Packit 8dc392
Packit 8dc392
#define THROW_ERRNO(text)                         \
Packit 8dc392
    do                                            \
Packit 8dc392
    {                                             \
Packit 8dc392
        std::stringstream s;                      \
Packit 8dc392
        s << text;                                \
Packit 8dc392
        ::IEX_NAMESPACE::throwErrnoExc (s.str()); \
Packit 8dc392
    }                                             \
Packit 8dc392
    while (0)
Packit 8dc392
Packit 8dc392
Packit 8dc392
//-------------------------------------------------------------
Packit 8dc392
// A macro to throw exceptions if an assertion is false.
Packit 8dc392
//
Packit 8dc392
// Example:
Packit 8dc392
//
Packit 8dc392
//	ASSERT (ptr != 0, NullExc, "Null pointer" );
Packit 8dc392
//
Packit 8dc392
//-------------------------------------------------------------
Packit 8dc392
Packit 8dc392
#define ASSERT(assertion, type, text)   \
Packit 8dc392
    do                                  \
Packit 8dc392
    {                                   \
Packit 8dc392
        if( (assertion) == false )      \
Packit 8dc392
        {                               \
Packit 8dc392
            THROW( type, text );        \
Packit 8dc392
        }                               \
Packit 8dc392
    }                                   \
Packit 8dc392
    while (0)
Packit 8dc392
Packit 8dc392
//-------------------------------------------------------------
Packit 8dc392
// A macro to throw an IEX_NAMESPACE::LogicExc if an assertion is false,
Packit 8dc392
// with the text composed from the source code file, line number,
Packit 8dc392
// and assertion argument text.
Packit 8dc392
//
Packit 8dc392
// Example:
Packit 8dc392
//
Packit 8dc392
//      LOGIC_ASSERT (i < n);
Packit 8dc392
//
Packit 8dc392
//-------------------------------------------------------------
Packit 8dc392
#define LOGIC_ASSERT(assertion)           \
Packit 8dc392
    ASSERT(assertion,                     \
Packit 8dc392
           IEX_NAMESPACE::LogicExc,       \
Packit 8dc392
           __FILE__ << "(" << __LINE__ << "): logical assertion failed: " << #assertion )
Packit 8dc392
Packit 8dc392
#endif