Exception.hxx 5.73 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
//-----------------------------------------------------------------------------
//
// Copyright (c) 1998 - 2007, The Regents of the University of California
// Produced at the Lawrence Livermore National Laboratory
// All rights reserved.
//
// This file is part of PyCXX. For details,see http://cxx.sourceforge.net/. The
// full copyright notice is contained in the file COPYRIGHT located at the root
// of the PyCXX distribution.
//
// Redistribution  and  use  in  source  and  binary  forms,  with  or  without
// modification, are permitted provided that the following conditions are met:
//
//  - Redistributions of  source code must  retain the above  copyright notice,
//    this list of conditions and the disclaimer below.
//  - Redistributions in binary form must reproduce the above copyright notice,
//    this  list of  conditions  and  the  disclaimer (as noted below)  in  the
//    documentation and/or materials provided with the distribution.
//  - Neither the name of the UC/LLNL nor  the names of its contributors may be
//    used to  endorse or  promote products derived from  this software without
//    specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT  HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR  IMPLIED WARRANTIES, INCLUDING,  BUT NOT  LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE
// ARE  DISCLAIMED.  IN  NO  EVENT  SHALL  THE  REGENTS  OF  THE  UNIVERSITY OF
// CALIFORNIA, THE U.S.  DEPARTMENT  OF  ENERGY OR CONTRIBUTORS BE  LIABLE  FOR
// ANY  DIRECT,  INDIRECT,  INCIDENTAL,  SPECIAL,  EXEMPLARY,  OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT  LIMITED TO, PROCUREMENT OF  SUBSTITUTE GOODS OR
// SERVICES; LOSS OF  USE, DATA, OR PROFITS; OR  BUSINESS INTERRUPTION) HOWEVER
// CAUSED  AND  ON  ANY  THEORY  OF  LIABILITY,  WHETHER  IN  CONTRACT,  STRICT
// LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)  ARISING IN ANY  WAY
// OUT OF THE  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.
//
//-----------------------------------------------------------------------------

#ifndef __CXX_Exception_h
#define __CXX_Exception_h

#include "CXX/WrapPython.h"
#include "CXX/Version.hxx"
#include "CXX/Config.hxx"
#include "CXX/CxxDebug.hxx"
#include "CXX/IndirectPythonInterface.hxx"

#include <string>
#include <iostream>

// This mimics the Python structure, in order to minimize confusion
namespace Py
{
    class ExtensionExceptionType;

    class Object;

    class BaseException
    {
    public:
        BaseException( ExtensionExceptionType &exception, const std::string &reason );
        BaseException( ExtensionExceptionType &exception, Object &reason );
        BaseException( PyObject *exception, Object &reason );
        BaseException( PyObject *exception, const std::string &reason );
        explicit BaseException();

        void clear(); // clear the error

        // is the exception this specific exception 'exc'
        bool matches( ExtensionExceptionType &exc );
    };

    // for user defined exceptions to be made know to pycxx
    typedef void (*throw_exception_func_t)( void );
    void addPythonException( ExtensionExceptionType &py_exc_type, throw_exception_func_t throw_func );

#if defined( PYCXX_6_2_COMPATIBILITY )
    class Exception : public BaseException
    {
    public:
        Exception( ExtensionExceptionType &exception, const std::string &reason )
        : BaseException( exception, reason )
        {}

        Exception( ExtensionExceptionType &exception, Object &reason )
        : BaseException( exception, reason )
        {}

88 89 90 91
        Exception( PyObject *exception, Object &reason  )
        : BaseException( exception, reason  )
        {}

92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
        Exception( PyObject *exception, const std::string &reason )
        : BaseException( exception, reason )
        {}

        explicit Exception()
        : BaseException()
        {}
    };
#endif

#define PYCXX_STANDARD_EXCEPTION( eclass, bclass ) \
    class eclass : public bclass \
    { \
    public: \
        eclass() {} \
        eclass( const char *reason ) { PyErr_SetString( _Exc_##eclass(), reason ); } \
        eclass( const std::string &reason ) { PyErr_SetString( _Exc_##eclass(), reason.c_str() ); } \
        ~eclass() {} \
        \
        static void throwFunc() { throw eclass(); } \
        static PyObject *exceptionType() { return _Exc_##eclass(); } \
    }; \

#include <CXX/Python3/cxx_standard_exceptions.hxx>

#undef PYCXX_STANDARD_EXCEPTION

#define PYCXX_USER_EXCEPTION_STR_ARG( uclass ) \
class uclass : public Py::BaseException \
{ \
public: \
    uclass( const std::string &reason ) \
    : Py::BaseException( m_error, reason ) \
    { } \
    ~uclass() {} \
    static void init( Py::ExtensionModuleBase &module ) \
    { \
        m_error.init( module, #uclass ); \
        Py::addPythonException( m_error, throwFunc ); \
        Py::Dict d( module.moduleDictionary() ); \
        d[#uclass] = m_error; \
    } \
private: \
    uclass() : Py::BaseException() {} \
    static void throwFunc() \
    { \
        throw uclass(); \
    } \
    static Py::ExtensionExceptionType m_error; \
}; \
Py::ExtensionExceptionType uclass::m_error;

#define PYCXX_USER_EXCEPTION_NO_ARG( uclass ) \
class uclass : public Py::BaseException \
{ \
public: \
    uclass() \
    : Py::BaseException() \
    { } \
    ~uclass() {} \
    static void init( Py::ExtensionModuleBase &module ) \
    { \
        m_error.init( module, #uclass ); \
        Py::addPythonException( m_error, throwFunc ); \
        Py::Dict d( module.moduleDictionary() ); \
        d[#uclass] = m_error; \
    } \
private: \
    static void throwFunc() \
    { \
        throw uclass(); \
    } \
    static Py::ExtensionExceptionType m_error; \
}; \
Py::ExtensionExceptionType uclass::m_error;

}// Py

#endif