User Manual, Developers Guide and API Documentation

Assure.hpp

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2007
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 16, D-52074 Aachen, Germany
 * phone: ++49-241-80-27910,
 * fax: ++49-241-80-22242
 * email: info@openwns.org
 * www: http://www.openwns.org
 * _____________________________________________________________________________
 *
 * openWNS is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 2 as published by the
 * Free Software Foundation;
 *
 * openWNS is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/

#ifndef WNS_ASSURE_HPP
#define WNS_ASSURE_HPP

#include <WNS/Exception.hpp>
#include <WNS/TypeInfo.hpp>

#include <cassert>
#include <sstream>
#include <iostream>
#include <string>
#include <csignal>

// WNS_NDEBUG means: assures are disabled
#if defined WNS_NDEBUG
#define assure(expr, reason) \
((void)0)

#define assureWithExceptionType(expr, reason, type) \
((void)0)

// WNS_ASSERT means: assure behaves like assert -> abort if expression is not true
#elif defined WNS_ASSERT
#define assure(expr, reason) \
if (true) \
{ \
    assert(expr); \
} \
else \
    void()

#define assureWithExceptionType(expr, reason, type) \
if (true) \
{ \
    assert(expr); \
} \
else \
    void()

// if nothing is defined: assure throws an exception if expression is not true
#else
#define assure(expr, reason) \
if (!(expr)) \
{ \
    std::stringstream s; \
    s.precision(10); \
    s<<reason; \
    wns::Assure::expression<wns::Assure::Exception>(#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__, (s.str())); \
} \
else \
    void()

#define assureWithExceptionType(expr, reason, type) \
if (!(expr)) \
{ \
    std::stringstream s; \
    s.precision(10); \
    s<<reason; wns::Assure::expression<type>(#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__, (s.str())); \
} else \
    void()

#define WNS_ASSURE_THROWS_EXCEPTION 1

#endif // WNS_NDEBUG


#define assureType(pointer, T) \
assure(dynamic_cast<T>(pointer), \
       std::string(#pointer) + " is not of type " + wns::TypeInfo::create<T>().toString() + \
                   " but of Type: " + wns::TypeInfo::create(*pointer).toString()+"*")

#define assureNotNull(pointer) \
assureWithExceptionType(NULL != pointer, \
               "Pointer " + std::string(#pointer) + " invalid (NULL)", wns::NullException)

namespace wns {

    class NullException :
        public wns::Exception
    {
    public:
        explicit
        NullException(const std::string& s);
        ~NullException() throw() {}
    };


    class Assure
    {
    public:
        static bool useSIGTRAP;

        class Exception :
            public wns::Exception
        {
        public:
            explicit
            Exception(const std::string& s);

      ~Exception() throw() {};
        };

        template<typename TYPE>
        static void
        expression(
            const std::string& expression,
            const std::string& fileName,
            int line,
            const std::string& functionName,
            const std::string& reason)
        {
            std::stringstream ss;
            ss << "In '"
               << functionName
               << "' ("
               << fileName
               << ":"
               << line
               << "):\nfailed assertion (" << expression << ")." << std::endl
               << "Reason: " << reason << std::endl;

            if (useSIGTRAP)
            {
                std::cerr << ss.str();
                raise(SIGTRAP);
            }
            else
            {
                TYPE e(ss.str());
                throw(e);
            }
        }

    };
}

#endif // WNS_ASSURE_HPP

---