error.hpp

Go to the documentation of this file.

/* Copyright (c) 2005-2012 Taneli Kalvas. All rights reserved.
 *
 * You can redistribute this software and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option)
 * any later version.
 * 
 * This library 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
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this library (file "COPYING" included in the package);
 * if not, write to the Free Software Foundation, Inc., 51 Franklin
 * Street, Fifth Floor, Boston, MA 02110-1301 USA
 * 
 * If you have questions about your rights to use or distribute this
 * software, please contact Berkeley Lab's Technology Transfer
 * Department at TTD@lbl.gov. Other questions, comments and bug
 * reports should be sent directly to the author via email at
 * taneli.kalvas@jyu.fi.
 * 
 * NOTICE. This software was developed under partial funding from the
 * U.S.  Department of Energy.  As such, the U.S. Government has been
 * granted for itself and others acting on its behalf a paid-up,
 * nonexclusive, irrevocable, worldwide license in the Software to
 * reproduce, prepare derivative works, and perform publicly and
 * display publicly.  Beginning five (5) years after the date
 * permission to assert copyright is obtained from the U.S. Department
 * of Energy, and subject to any subsequent five (5) year renewals,
 * the U.S. Government is granted for itself and others acting on its
 * behalf a paid-up, nonexclusive, irrevocable, worldwide license in
 * the Software to reproduce, prepare derivative works, distribute
 * copies to the public, perform publicly and display publicly, and to
 * permit others to do so.
 */

#ifndef ERROR_HPP
#define ERROR_HPP 1


#include "config.h"
#include <string>
#include <cstring>
#include <stdlib.h>
#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <sstream>
#include <errno.h>
#include <signal.h>


template <class T>
inline std::string to_string( const T& t )
{
    std::stringstream ss;
    ss << t;
    return( ss.str() );
}


#define ERROR_LOCATION ErrorLocation( __FILE__, __LINE__, __func__ )


class ErrorLocation {

    const char *_file;
    int         _line;
    const char *_func;

public:

    ErrorLocation();

    ErrorLocation( const char *file, int line, const char *func );

    std::string file( void );

    int line( void );

    std::string func( void );
};


class ExceptionTracer {

    void  *_traceaddress[25];
    int    _tracecount;

public:

    ExceptionTracer();

    void print_trace( std::ostream &os );
};


class Error : public ExceptionTracer {

    ErrorLocation  _loc;

protected:
    
    std::string    _error_str;

public:

    Error();

    Error( const std::string &str );

    Error( const ErrorLocation &loc );

    Error( const ErrorLocation &loc, const std::string &str );

    std::string get_error_message( void );

    void print_error_message( std::ostream &os, bool traceprint = true );
};


class ErrorNoMem : public Error {

public:

    ErrorNoMem( const ErrorLocation &loc );

    ErrorNoMem( const ErrorLocation &loc, const std::string &str );
};


class ErrorErrno : public Error {

    int _ierrno;

public:

    ErrorErrno( const ErrorLocation &loc );
};


class ErrorUnimplemented : public Error {

public:

    ErrorUnimplemented( const ErrorLocation &loc );

    ErrorUnimplemented( const ErrorLocation &loc, const std::string &str );
};


class ErrorAssert : public Error {

public:

    ErrorAssert( const ErrorLocation &loc );

    ErrorAssert( const ErrorLocation &loc, const std::string &str );
};


class ErrorDim : public Error {

public:

    ErrorDim( const ErrorLocation &loc );

    ErrorDim( const ErrorLocation &loc, const std::string &str );
};


class ErrorRange : public Error {

public:

    ErrorRange( const ErrorLocation &loc, 
                uint32_t i, uint32_t n, 
                uint32_t j, uint32_t m );

    ErrorRange( const ErrorLocation &loc, uint32_t i, uint32_t n );

    ErrorRange( const ErrorLocation &loc, uint32_t i, uint32_t n, const std::string &str );

    ErrorRange( const ErrorLocation &loc, const std::string &str );
};


class SignalHandler {

public:

#if defined(_GNU_SOURCE) && defined(HAVE_SIGINFO_T)

    static void signal_handler_SIGSEGV( int signum, siginfo_t *info, void *ptr );

    static void signal_handler_SIGTERM( int signum, siginfo_t *info, void *ptr );
#else

    static void signal_handler_SIGTERM( int signum );
#endif
};


#endif