Extensions.hxx 6.9 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
//-----------------------------------------------------------------------------
//
// 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_Extensions__h
#define __CXX_Extensions__h


#ifdef _MSC_VER
// disable warning C4786: symbol greater than 255 character,
// okay to ignore
#pragma warning( disable: 4786 )
#endif

#include "CXX/WrapPython.h"
#include "CXX/Version.hxx"
50 51 52
#include "CXX/Python2/Config.hxx"
#include "CXX/Python2/CxxDebug.hxx"
#include "CXX/Python2/Objects.hxx"
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76

extern "C" { extern PyObject py_object_initializer; }

#include <vector>
#include <map>

// ----------------------------------------------------------------------

namespace Py
{
    class ExtensionModuleBase;

    // Make an Exception Type for use in raising custom exceptions
    class ExtensionExceptionType : public Object
    {
    public:
        ExtensionExceptionType();
        virtual ~ExtensionExceptionType();

        // call init to create the type
        void init( ExtensionModuleBase &module, const std::string &name, ExtensionExceptionType &parent );
        void init( ExtensionModuleBase &module, const std::string &name );
    };

77
    class MethodTable
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
    {
    public:
        MethodTable();
        virtual ~MethodTable();

        void add( const char *method_name, PyCFunction f, const char *doc="", int flag=1 );
        PyMethodDef *table();

    protected:
        std::vector<PyMethodDef> t;    // accumulator of PyMethodDef's
        PyMethodDef *mt;        // Actual method table produced when full

        static PyMethodDef method( const char* method_name, PyCFunction f, int flags=1, const char* doc="" );

    private:
        //
        // prevent the compiler generating these unwanted functions
        //
        MethodTable( const MethodTable &m );    //unimplemented
        void operator=( const MethodTable &m );    //unimplemented

    }; // end class MethodTable

    // Note: Python calls noargs as varargs buts args==NULL
    extern "C" typedef PyObject *(*method_noargs_call_handler_t)( PyObject *_self, PyObject * );
    extern "C" typedef PyObject *(*method_varargs_call_handler_t)( PyObject *_self, PyObject *_args );
    extern "C" typedef PyObject *(*method_keyword_call_handler_t)( PyObject *_self, PyObject *_args, PyObject *_dict );

    template<class T>
107
    class MethodDefExt
108 109 110 111 112 113 114 115
    {
    public:
        typedef Object (T::*method_noargs_function_t)();
        typedef Object (T::*method_varargs_function_t)( const Tuple &args );
        typedef Object (T::*method_keyword_function_t)( const Tuple &args, const Dict &kws );

        // NOARGS
        MethodDefExt
116
        (
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
            const char *_name,
            method_noargs_function_t _function,
            method_noargs_call_handler_t _handler,
            const char *_doc
        )
        {
            ext_meth_def.ml_name = const_cast<char *>( _name );
            ext_meth_def.ml_meth = reinterpret_cast<method_varargs_call_handler_t>( _handler );
            ext_meth_def.ml_flags = METH_NOARGS;
            ext_meth_def.ml_doc = const_cast<char *>( _doc );

            ext_noargs_function = _function;
            ext_varargs_function = NULL;
            ext_keyword_function = NULL;
        }

        // VARARGS
        MethodDefExt
135
        (
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
            const char *_name,
            method_varargs_function_t _function,
            method_varargs_call_handler_t _handler,
            const char *_doc
        )
        {
            ext_meth_def.ml_name = const_cast<char *>( _name );
            ext_meth_def.ml_meth = reinterpret_cast<method_varargs_call_handler_t>( _handler );
            ext_meth_def.ml_flags = METH_VARARGS;
            ext_meth_def.ml_doc = const_cast<char *>( _doc );

            ext_noargs_function = NULL;
            ext_varargs_function = _function;
            ext_keyword_function = NULL;
        }

        // VARARGS + KEYWORD
        MethodDefExt
154
        (
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
            const char *_name,
            method_keyword_function_t _function,
            method_keyword_call_handler_t _handler,
            const char *_doc
        )
        {
            ext_meth_def.ml_name = const_cast<char *>( _name );
            ext_meth_def.ml_meth = reinterpret_cast<method_varargs_call_handler_t>( _handler );
            ext_meth_def.ml_flags = METH_VARARGS|METH_KEYWORDS;
            ext_meth_def.ml_doc = const_cast<char *>( _doc );

            ext_noargs_function = NULL;
            ext_varargs_function = NULL;
            ext_keyword_function = _function;
        }

        ~MethodDefExt()
        {}

        PyMethodDef ext_meth_def;
175 176 177 178
        method_noargs_function_t ext_noargs_function;
        method_varargs_function_t ext_varargs_function;
        method_keyword_function_t ext_keyword_function;
        Object py_method;
179 180 181
    };
} // Namespace Py

182 183 184 185 186
#include "CXX/Python2/ExtensionModule.hxx"
#include "CXX/Python2/PythonType.hxx"
#include "CXX/Python2/ExtensionTypeBase.hxx"
#include "CXX/Python2/ExtensionOldType.hxx"
#include "CXX/Python2/ExtensionType.hxx"
187 188 189

// End of CXX_Extensions.h
#endif