/brz/remove-bazaar

/* Copyright (C) 2009 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

 */

/* Must be defined before importing _static_tuple_c.h so that we get the right

 * linkage.

 */

#define STATIC_TUPLE_MODULE

#include <Python.h>

#include "python-compat.h"

#include "_static_tuple_c.h"

#include "_export_c_api.h"

/* Pyrex 0.9.6.4 exports _simple_set_pyx_api as

 * import__simple_set_pyx(), while Pyrex 0.9.8.5 and Cython 0.11.3 export them

 * as import_bzrlib___simple_set_pyx(). As such, we just #define one to be

 * equivalent to the other in our internal code.

 */

#define import__simple_set_pyx import_bzrlib___simple_set_pyx

#include "_simple_set_pyx_api.h"

#if defined(__GNUC__)

#   define inline __inline__

#elif defined(_MSC_VER)

#   define inline __inline

#else

#   define inline

#endif

/* The one and only StaticTuple with no values */

static StaticTuple *_empty_tuple = NULL;

static PyObject *_interned_tuples = NULL;

static inline int

_StaticTuple_is_interned(StaticTuple *self)

{

    return self->flags & STATIC_TUPLE_INTERNED_FLAG;

}

static PyObject *

StaticTuple_as_tuple(StaticTuple *self)

{

    PyObject *tpl = NULL, *obj = NULL;

    int i, len;

    len = self->size;

    tpl = PyTuple_New(len);

    if (!tpl) {

        /* Malloc failure */

        return NULL;

    }

    for (i = 0; i < len; ++i) {

        obj = (PyObject *)self->items[i];

        Py_INCREF(obj);

        PyTuple_SET_ITEM(tpl, i, obj);

    }

    return tpl;

}

static char StaticTuple_as_tuple_doc[] = "as_tuple() => tuple";

static StaticTuple *

StaticTuple_Intern(StaticTuple *self)

{

    PyObject *canonical_tuple = NULL;

    if (_interned_tuples == NULL || _StaticTuple_is_interned(self)) {

        Py_INCREF(self);

        return self;

    }

    /* SimpleSet_Add returns whatever object is present at self

     * or the new object if it needs to add it.

     */

    canonical_tuple = SimpleSet_Add(_interned_tuples, (PyObject *)self);

    if (!canonical_tuple) {

        // Some sort of exception, propogate it.

        return NULL;

    }

    if (canonical_tuple != (PyObject *)self) {

        // There was already a tuple with that value

        return (StaticTuple *)canonical_tuple;

    }

    self->flags |= STATIC_TUPLE_INTERNED_FLAG;

    // The two references in the dict do not count, so that the StaticTuple

    // object does not become immortal just because it was interned.

    Py_REFCNT(self) -= 1;

    return self;

}

static char StaticTuple_Intern_doc[] = "intern() => unique StaticTuple\n"

    "Return a 'canonical' StaticTuple object.\n"

    "Similar to intern() for strings, this makes sure there\n"

    "is only one StaticTuple object for a given value\n."

    "Common usage is:\n"

    "  key = StaticTuple('foo', 'bar').intern()\n";

static void

StaticTuple_dealloc(StaticTuple *self)

{

    int i, len;

    if (_StaticTuple_is_interned(self)) {

        /* revive dead object temporarily for Discard */

        Py_REFCNT(self) = 2;

        if (SimpleSet_Discard(_interned_tuples, (PyObject*)self) != 1)

            Py_FatalError("deletion of interned StaticTuple failed");

        self->flags &= ~STATIC_TUPLE_INTERNED_FLAG;

    }

    len = self->size;

    for (i = 0; i < len; ++i) {

        Py_XDECREF(self->items[i]);

    }

    Py_TYPE(self)->tp_free((PyObject *)self);

}

/* Similar to PyTuple_New() */

static StaticTuple *

StaticTuple_New(Py_ssize_t size)

{

    StaticTuple *stuple;

    if (size < 0) {

        PyErr_BadInternalCall();

        return NULL;

    }

    if (size == 0 && _empty_tuple != NULL) {

        Py_INCREF(_empty_tuple);

        return _empty_tuple;

    }

    /* Note that we use PyObject_NewVar because we want to allocate a variable

     * width entry. However we *aren't* truly a PyVarObject because we don't

     * use a long for ob_size. Instead we use a plain 'size' that is an int,

     * and will be overloaded with flags in the future.

     * As such we do the alloc, and then have to clean up anything it does

     * incorrectly.

     */

    stuple = PyObject_NewVar(StaticTuple, &StaticTuple_Type, size);

    if (stuple == NULL) {

        return NULL;

    }

    stuple->size = size;

    stuple->flags = 0;

    stuple->_unused0 = 0;

    stuple->_unused1 = 0;

    if (size > 0) {

        memset(stuple->items, 0, sizeof(PyObject *) * size);

    }

#if STATIC_TUPLE_HAS_HASH

    stuple->hash = -1;

#endif

    return stuple;

}

static PyObject *

StaticTuple_new_constructor(PyTypeObject *type, PyObject *args, PyObject *kwds)

{

    StaticTuple *self;

    PyObject *obj = NULL;

    Py_ssize_t i, len = 0;

    if (type != &StaticTuple_Type) {

        PyErr_SetString(PyExc_TypeError, "we only support creating StaticTuple");

        return NULL;

    }

    if (!PyTuple_CheckExact(args)) {

        PyErr_SetString(PyExc_TypeError, "args must be a tuple");

        return NULL;

    }

    len = PyTuple_GET_SIZE(args);

    if (len < 0 || len > 255) {

        /* Too big or too small */

        PyErr_SetString(PyExc_ValueError, "StaticTuple.__init__(...)"

            " takes from 0 to 255 items");

        return NULL;

    }

    self = (StaticTuple *)StaticTuple_New(len);

    if (self == NULL) {

        return NULL;

    }

    for (i = 0; i < len; ++i) {

        obj = PyTuple_GET_ITEM(args, i);

        if (!PyString_CheckExact(obj)) {

            if (!StaticTuple_CheckExact(obj)) {

                PyErr_SetString(PyExc_TypeError, "StaticTuple.__init__(...)"

                    " requires that all items are strings or StaticTuple.");

                type->tp_dealloc((PyObject *)self);

                return NULL;

            }

        }

        Py_INCREF(obj);

        self->items[i] = obj;

    }

    return (PyObject *)self;

}

static PyObject *

StaticTuple_repr(StaticTuple *self)

{

    PyObject *as_tuple, *tuple_repr, *result;

    as_tuple = StaticTuple_as_tuple(self);

    if (as_tuple == NULL) {

        return NULL;

    }

    tuple_repr = PyObject_Repr(as_tuple);

    Py_DECREF(as_tuple);

    if (tuple_repr == NULL) {

        return NULL;

    }

    result = PyString_FromFormat("%s%s", Py_TYPE(self)->tp_name,

                                         PyString_AsString(tuple_repr));

    return result;

}

static long

StaticTuple_hash(StaticTuple *self)

{

    /* adapted from tuplehash(), is the specific hash value considered

     * 'stable'?

     */

    register long x, y;

    Py_ssize_t len = self->size;

    PyObject **p;

    long mult = 1000003L;

#if STATIC_TUPLE_HAS_HASH

    if (self->hash != -1) {

        return self->hash;

    }

#endif

    x = 0x345678L;

    p = self->items;

    // TODO: We could set specific flags if we know that, for example, all the

    //       items are strings. I haven't seen a real-world benefit to that

    //       yet, though.

    while (--len >= 0) {

        y = PyObject_Hash(*p++);

        if (y == -1) /* failure */

            return -1;

        x = (x ^ y) * mult;

        /* the cast might truncate len; that doesn't change hash stability */

        mult += (long)(82520L + len + len);

    }

    x += 97531L;

    if (x == -1)

        x = -2;

#if STATIC_TUPLE_HAS_HASH

    self->hash = x;

#endif

    return x;

}

static PyObject *

StaticTuple_richcompare_to_tuple(StaticTuple *v, PyObject *wt, int op)

{

    PyObject *vt;

    PyObject *result = NULL;

    vt = StaticTuple_as_tuple((StaticTuple *)v);

    if (vt == NULL) {

        goto done;

    }

    if (!PyTuple_Check(wt)) {

        PyErr_BadInternalCall();

        goto done;

    }

    /* Now we have 2 tuples to compare, do it */

    result = PyTuple_Type.tp_richcompare(vt, wt, op);

done:

    Py_XDECREF(vt);

    return result;

}

/** Compare two objects to determine if they are equivalent.

 * The basic flow is as follows

 *  1) First make sure that both objects are StaticTuple instances. If they

 *     aren't then cast self to a tuple, and have the tuple do the comparison.

 *  2) Special case comparison to Py_None, because it happens to occur fairly

 *     often in the test suite.

 *  3) Special case when v and w are the same pointer. As we know the answer to

 *     all queries without walking individual items.

 *  4) For all operations, we then walk the items to find the first paired

 *     items that are not equal.

 *  5) If all items found are equal, we then check the length of self and

 *     other to determine equality.

 *  6) If an item differs, then we apply "op" to those last two items. (eg.

 *     StaticTuple(A, B) > StaticTuple(A, C) iff B > C)

 */

static PyObject *

StaticTuple_richcompare(PyObject *v, PyObject *w, int op)

{

    StaticTuple *v_st, *w_st;

    Py_ssize_t vlen, wlen, min_len, i;

    PyObject *v_obj, *w_obj;

    richcmpfunc string_richcompare;

    if (!StaticTuple_CheckExact(v)) {

        /* This has never triggered, according to python-dev it seems this

         * might trigger if '__op__' is defined but '__rop__' is not, sort of

         * case. Such as "None == StaticTuple()"

         */

        fprintf(stderr, "self is not StaticTuple\n");

        Py_INCREF(Py_NotImplemented);

        return Py_NotImplemented;

    }

    v_st = (StaticTuple *)v;

    if (StaticTuple_CheckExact(w)) {

        /* The most common case */

        w_st = (StaticTuple*)w;

    } else if (PyTuple_Check(w)) {

        /* One of v or w is a tuple, so we go the 'slow' route and cast up to

         * tuples to compare.

         */

        /* TODO: This seems to be triggering more than I thought it would...

         *       We probably want to optimize comparing self to other when

         *       other is a tuple.

         */

        return StaticTuple_richcompare_to_tuple(v_st, w, op);

    } else if (w == Py_None) {

        // None is always less than the object

        switch (op) {

        case Py_NE:case Py_GT:case Py_GE:

            Py_INCREF(Py_True);

            return Py_True;

        case Py_EQ:case Py_LT:case Py_LE:

            Py_INCREF(Py_False);

            return Py_False;

    default: // Should never happen

        return Py_NotImplemented;

        }

    } else {

        /* We don't special case this comparison, we just let python handle

         * it.

         */

         Py_INCREF(Py_NotImplemented);

         return Py_NotImplemented;

    }

    /* Now we know that we have 2 StaticTuple objects, so let's compare them.

     * This code is inspired from tuplerichcompare, except we know our

     * objects are limited in scope, so we can inline some comparisons.

     */

    if (v == w) {

        /* Identical pointers, we can shortcut this easily. */

        switch (op) {

        case Py_EQ:case Py_LE:case Py_GE:

            Py_INCREF(Py_True);

            return Py_True;

        case Py_NE:case Py_LT:case Py_GT:

            Py_INCREF(Py_False);

            return Py_False;

        }

    }

    if (op == Py_EQ

        && _StaticTuple_is_interned(v_st)

        && _StaticTuple_is_interned(w_st))

    {

        /* If both objects are interned, we know they are different if the

         * pointer is not the same, which would have been handled by the

         * previous if. No need to compare the entries.

         */

        Py_INCREF(Py_False);

        return Py_False;

    }

    /* The only time we are likely to compare items of different lengths is in

     * something like the interned_keys set. However, the hash is good enough

     * that it is rare. Note that 'tuple_richcompare' also does not compare

     * lengths here.

     */

    vlen = v_st->size;

    wlen = w_st->size;

    min_len = (vlen < wlen) ? vlen : wlen;

    string_richcompare = PyString_Type.tp_richcompare;

    for (i = 0; i < min_len; i++) {

        PyObject *result = NULL;

        v_obj = StaticTuple_GET_ITEM(v_st, i);

        w_obj = StaticTuple_GET_ITEM(w_st, i);

        if (v_obj == w_obj) {

            /* Shortcut case, these must be identical */

            continue;

        }

        if (PyString_CheckExact(v_obj) && PyString_CheckExact(w_obj)) {

            result = string_richcompare(v_obj, w_obj, Py_EQ);

        } else if (StaticTuple_CheckExact(v_obj) &&

                   StaticTuple_CheckExact(w_obj))

        {

            /* Both are StaticTuple types, so recurse */

            result = StaticTuple_richcompare(v_obj, w_obj, Py_EQ);

        } else {

            /* Not the same type, obviously they won't compare equal */

            break;

        }

        if (result == NULL) {

            return NULL; /* There seems to be an error */

        }

        if (result == Py_NotImplemented) {

            Py_DECREF(result);

            /* One side must have had a string and the other a StaticTuple.

             * This clearly means that they are not equal.

             */

            if (op == Py_EQ) {

                Py_INCREF(Py_False);

                return Py_False;

            }

            result = PyObject_RichCompare(v_obj, w_obj, Py_EQ);

        }

        if (result == Py_False) {

            /* This entry is not identical

             * Shortcut for Py_EQ

             */

            if (op == Py_EQ) {

                return result;

            }

            Py_DECREF(result);

            break;

        }

        if (result != Py_True) {

            /* We don't know *what* richcompare is returning, but it

             * isn't something we recognize

             */

            PyErr_BadInternalCall();

            Py_DECREF(result);

            return NULL;

        }

        Py_DECREF(result);

    }

    if (i >= min_len) {

        /* We walked off one of the lists, but everything compared equal so

         * far. Just compare the size.

         */

        int cmp;

        PyObject *res;

        switch (op) {

        case Py_LT: cmp = vlen <  wlen; break;

        case Py_LE: cmp = vlen <= wlen; break;

        case Py_EQ: cmp = vlen == wlen; break;

        case Py_NE: cmp = vlen != wlen; break;

        case Py_GT: cmp = vlen >  wlen; break;

        case Py_GE: cmp = vlen >= wlen; break;

        default: return NULL; /* cannot happen */

        }

        if (cmp)

            res = Py_True;

        else

            res = Py_False;

        Py_INCREF(res);

        return res;

    }

    /* The last item differs, shortcut the Py_NE case */

    if (op == Py_NE) {

        Py_INCREF(Py_True);

        return Py_True;

    }

    /* It is some other comparison, go ahead and do the real check. */

    if (PyString_CheckExact(v_obj) && PyString_CheckExact(w_obj))

    {

        return string_richcompare(v_obj, w_obj, op);

    } else if (StaticTuple_CheckExact(v_obj) &&

               StaticTuple_CheckExact(w_obj))

    {

        /* Both are StaticTuple types, so recurse */

        return StaticTuple_richcompare(v_obj, w_obj, op);

    } else {

        Py_INCREF(Py_NotImplemented);

        return Py_NotImplemented;

    }

}

static Py_ssize_t

StaticTuple_length(StaticTuple *self)

{

    return self->size;

}

static PyObject *

StaticTuple__is_interned(StaticTuple *self)

{

    if (_StaticTuple_is_interned(self)) {

        Py_INCREF(Py_True);

        return Py_True;

    }

    Py_INCREF(Py_False);

    return Py_False;

}

static char StaticTuple__is_interned_doc[] = "_is_interned() => True/False\n"

    "Check to see if this tuple has been interned.\n";

static PyObject *

StaticTuple_item(StaticTuple *self, Py_ssize_t offset)

{

    PyObject *obj;

    /* We cast to (int) to avoid worrying about whether Py_ssize_t is a

     * long long, etc. offsets should never be >2**31 anyway.

     */

    if (offset < 0) {

        PyErr_Format(PyExc_IndexError, "StaticTuple_item does not support"

            " negative indices: %d\n", (int)offset);

    } else if (offset >= self->size) {

        PyErr_Format(PyExc_IndexError, "StaticTuple index out of range"

            " %d >= %d", (int)offset, (int)self->size);

        return NULL;

    }

    obj = (PyObject *)self->items[offset];

    Py_INCREF(obj);

    return obj;

}

static PyObject *

StaticTuple_slice(StaticTuple *self, Py_ssize_t ilow, Py_ssize_t ihigh)

{

    PyObject *as_tuple, *result;

    as_tuple = StaticTuple_as_tuple(self);

    if (as_tuple == NULL) {

        return NULL;

    }

    result = PyTuple_Type.tp_as_sequence->sq_slice(as_tuple, ilow, ihigh);

    Py_DECREF(as_tuple);

    return result;

}

static int

StaticTuple_traverse(StaticTuple *self, visitproc visit, void *arg)

{

    Py_ssize_t i;

    for (i = self->size; --i >= 0;) {

        Py_VISIT(self->items[i]);

    }

    return 0;

}

static char StaticTuple_doc[] =

    "C implementation of a StaticTuple structure."

    "\n This is used as StaticTuple(item1, item2, item3)"

    "\n This is similar to tuple, less flexible in what it"

    "\n supports, but also lighter memory consumption."

    "\n Note that the constructor mimics the () form of tuples"

    "\n Rather than the 'tuple()' constructor."

    "\n  eg. StaticTuple(a, b) == (a, b) == tuple((a, b))";

static PyMethodDef StaticTuple_methods[] = {

    {"as_tuple", (PyCFunction)StaticTuple_as_tuple, METH_NOARGS, StaticTuple_as_tuple_doc},

    {"intern", (PyCFunction)StaticTuple_Intern, METH_NOARGS, StaticTuple_Intern_doc},

    {"_is_interned", (PyCFunction)StaticTuple__is_interned, METH_NOARGS,

     StaticTuple__is_interned_doc},

    {NULL, NULL} /* sentinel */

};

static PySequenceMethods StaticTuple_as_sequence = {

    (lenfunc)StaticTuple_length,            /* sq_length */

    0,                              /* sq_concat */

    0,                              /* sq_repeat */

    (ssizeargfunc)StaticTuple_item,         /* sq_item */

    (ssizessizeargfunc)StaticTuple_slice,   /* sq_slice */

    0,                              /* sq_ass_item */

    0,                              /* sq_ass_slice */

    0,                              /* sq_contains */

};

/* TODO: Implement StaticTuple_as_mapping.