BaseException.h

Go to the documentation of this file.

#ifndef CARMA_UTIL_BASE_EXCEPTION_H
#define CARMA_UTIL_BASE_EXCEPTION_H

#include <exception>
#include <string>
#include <iosfwd>
#include <vector>
#include <memory>
#include <cstdlib>
#include <cstring>

#include <log4cpp/Priority.hh>

#include "carma/util/Backtrace.h"


namespace carma  {
namespace util  {

class BaseException : public ::std::exception  {
    public:
        virtual ~BaseException( ) throw( );

        virtual const char * what( ) const throw( );

        virtual void setMessageDirectly( const char * mesg );

        virtual void setMessageToCopy( const char * mesg );

        virtual void setMessageToCopy( const ::std::string & mesg );

        virtual void setMessageToCopy( const ::std::ostringstream & oss );

        virtual const char * getMessage( ) const;

        virtual const char * getSourceFile( ) const;

        virtual int getLineNumber( ) const;


        virtual ::std::string getLogString( ) const;

        void logException( log4cpp::Priority::PriorityLevel priority ) const;

        Backtrace getBacktrace( ) const;

    protected:
        explicit BaseException( );
        
        BaseException( const BaseException & rhs );

        BaseException( const char * mesg,
                       const char * fileName,
                       const int    lineNo );

        BaseException( const char *          mesg,
                       const ::std::string & fileName,
                       const int             lineNo );

        BaseException( const ::std::string & mesg,
                       const char *          fileName,
                       const int             lineNo );

        BaseException( const ::std::string & mesg,
                       const ::std::string & fileName,
                       const int             lineNo );

        BaseException( const ::std::ostringstream & oss,
                       const char *                 fileName,
                       const int                    lineNo );

        BaseException( const ::std::ostringstream & oss,
                       const ::std::string &        fileName,
                       const int                    lineNo );

        BaseException & operator=( const BaseException & rhs );

        virtual void setLineNumber( int num );

        void setSourceFileDirectly( const char * file );

        void setSourceFileToCopy( const char * file );
        void setSourceFileToCopy( const ::std::string & file );

    private:
        void clearMesg( );
        void clearSourceFile( );
        
        void swap( BaseException & rhs );

        const char *        mesg_;
        bool                weAllocatedMesg_;
        const char *        sourceFile_;
        bool                weAllocatedSourceFile_;
        int                 lineNo_;
        Backtrace           backtrace_;
};  // class BaseException


}  // namespace carma::util
}  // namespace carma


#define CARMA_EXCEPTION(x,y) x((y), __FILE__, __LINE__)

#define CARMA_TEST( e, ce, m )                            \
do {                                                      \
    if ( ! (e) )                                          \
    {                                                     \
        ::std::ostringstream os;                          \
        os << "CARMA_TEST FAIL: " << m;                   \
        ce error( os, __FILE__, __LINE__);                \
        error.logException(::log4cpp::Priority::ERROR);   \
        throw error;                                      \
    }                                                     \
} while (false)

#endif    // CARMA_UTIL_BASE_EXCEPTION_H