PythonType.hxx 8.07 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
//-----------------------------------------------------------------------------
//
// 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_PythonType__h
#define __CXX_PythonType__h

41 42 43 44
#if defined( Py_LIMITED_API )
#include <unordered_map>
#endif

45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
namespace Py
{
    class PythonType
    {
    public:
        // if you define one sequence method you must define 
        // all of them except the assigns

        PythonType( size_t base_size, int itemsize, const char *default_name );
        virtual ~PythonType();

        const char *getName() const;
        const char *getDoc() const;

        PyTypeObject *type_object() const;
        PythonType &name( const char *nam );
        PythonType &doc( const char *d );

        PythonType &supportClass( void );
64
#if defined( PYCXX_PYTHON_2TO3 ) && !defined( Py_LIMITED_API )
65 66 67 68 69 70
        PythonType &supportPrint( void );
#endif
        PythonType &supportGetattr( void );
        PythonType &supportSetattr( void );
        PythonType &supportGetattro( void );
        PythonType &supportSetattro( void );
71
#ifdef PYCXX_PYTHON_2TO3
72
        PythonType &supportCompare( void );
73
#endif
74 75 76 77 78 79
        PythonType &supportRichCompare( void );
        PythonType &supportRepr( void );
        PythonType &supportStr( void );
        PythonType &supportHash( void );
        PythonType &supportCall( void );

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 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
#define B( n ) (1<<(n))
        enum {
            support_iter_iter =                 B(0),
            support_iter_iternext =             B(1)
        };
        PythonType &supportIter( int methods_to_support=
                        support_iter_iter |
                        support_iter_iternext );

        enum {
            support_sequence_length =           B(0),
            support_sequence_repeat =           B(1),
            support_sequence_item =             B(2),
            support_sequence_slice =            B(3),
            support_sequence_concat =           B(4),
            support_sequence_ass_item =         B(5),
            support_sequence_ass_slice =        B(6),
            support_sequence_inplace_concat =   B(7),
            support_sequence_inplace_repeat =   B(8),
            support_sequence_contains =         B(9)
        };
        PythonType &supportSequenceType( int methods_to_support=
                        support_sequence_length |
                        support_sequence_repeat |
                        support_sequence_item |
                        support_sequence_slice |
                        support_sequence_concat
                        );

        enum {
            support_mapping_length =            B(0),
            support_mapping_subscript =         B(1),
            support_mapping_ass_subscript =     B(2)
        };
        PythonType &supportMappingType( int methods_to_support=
                        support_mapping_length |
                        support_mapping_subscript
                        );

        enum {
            support_number_add =                B(0),
            support_number_subtract =           B(1),
            support_number_multiply =           B(2),
            support_number_remainder =          B(3),
            support_number_divmod =             B(4),
            support_number_power =              B(5),
            support_number_negative =           B(6),
            support_number_positive =           B(7),
            support_number_absolute =           B(8),
            support_number_invert =             B(9),
            support_number_lshift =             B(10),
            support_number_rshift =             B(11),
            support_number_and =                B(12),
            support_number_xor =                B(13),
            support_number_or =                 B(14),
            support_number_int =                B(15),
            support_number_float=               B(16)
        };
        PythonType &supportNumberType( int methods_to_support=
                    support_number_add |
                    support_number_subtract |
                    support_number_multiply |
                    support_number_remainder |
                    support_number_divmod |
                    support_number_power |
                    support_number_negative |
                    support_number_positive |
                    support_number_absolute |
                    support_number_invert |
                    support_number_lshift |
                    support_number_rshift |
                    support_number_and |
                    support_number_xor |
                    support_number_or |
                    support_number_int |
                    support_number_float
                    );
157
#if !defined( Py_LIMITED_API )
158 159 160 161 162 163 164 165
        enum {
            support_buffer_getbuffer =          B(0),
            support_buffer_releasebuffer =      B(1)
        };
        PythonType &supportBufferType( int methods_to_support=
                    support_buffer_getbuffer |
                    support_buffer_releasebuffer
                    );
166
#endif
167
#undef B
168 169 170 171 172 173 174 175 176 177

        PythonType &set_tp_dealloc( void (*tp_dealloc)( PyObject * ) );
        PythonType &set_tp_init( int (*tp_init)( PyObject *self, PyObject *args, PyObject *kwds ) );
        PythonType &set_tp_new( PyObject *(*tp_new)( PyTypeObject *subtype, PyObject *args, PyObject *kwds ) );
        PythonType &set_methods( PyMethodDef *methods );

        // call once all support functions have been called to ready the type
        bool readyType();

    protected:
178 179 180 181 182
#if defined( Py_LIMITED_API )
        std::unordered_map<int, void*>  slots;
        PyType_Spec                     *spec;
        PyTypeObject                    *tp_object;
#else
183 184 185 186 187
        PyTypeObject            *table;
        PySequenceMethods       *sequence_table;
        PyMappingMethods        *mapping_table;
        PyNumberMethods         *number_table;
        PyBufferProcs           *buffer_table;
188
#endif
189 190 191 192 193 194 195 196 197 198 199 200 201 202

    private:
        //
        // prevent the compiler generating these unwanted functions
        //
        PythonType( const PythonType &tb );     // unimplemented
        void operator=( const PythonType &t );  // unimplemented

    };

} // Namespace Py

// End of __CXX_PythonType__h
#endif