~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2009, 2010 Canonical Ltd

#

# This program is free software; you can redistribute it 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 program 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 program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

"""The interface definition file for the StaticTuple class."""

cdef extern from "Python.h":

    ctypedef int Py_ssize_t # Required for older pyrex versions

    ctypedef struct PyObject:

        pass

cdef extern from "_static_tuple_c.h":

    ctypedef class bzrlib._static_tuple_c.StaticTuple [object StaticTuple]:

        cdef unsigned char size

        cdef unsigned char flags

        cdef PyObject *items[0]

    # Must be called before using any of the C api, as it sets the function

    # pointers in memory.

    int import_static_tuple_c() except -1

    StaticTuple StaticTuple_New(Py_ssize_t)

    StaticTuple StaticTuple_Intern(StaticTuple)

    StaticTuple StaticTuple_FromSequence(object)

    # Steals a reference and val must be a valid type, no checking is done

    void StaticTuple_SET_ITEM(StaticTuple key, Py_ssize_t offset, object val)

    # We would normally use PyObject * here. However it seems that cython/pyrex

    # treat the PyObject defined in this header as something different than one

    # defined in a .pyx file. And since we don't INCREF, we need a raw pointer,

    # not an 'object' return value.

    void *StaticTuple_GET_ITEM(StaticTuple key, Py_ssize_t offset)

    int StaticTuple_CheckExact(object)

    Py_ssize_t StaticTuple_GET_SIZE(StaticTuple key)