bytearrayobject.c 89.2 KB
Newer Older
1 2 3 4 5 6 7
/* PyByteArray (bytearray) implementation */

#define PY_SSIZE_T_CLEAN
#include "Python.h"
#include "structmember.h"
#include "bytes_methods.h"

8
char _PyByteArray_empty_string[] = "";
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

void
PyByteArray_Fini(void)
{
}

int
PyByteArray_Init(void)
{
    return 1;
}

/* end nullbytes support */

/* Helpers */

static int
_getbytevalue(PyObject* arg, int *value)
{
    long face_value;

    if (PyLong_Check(arg)) {
        face_value = PyLong_AsLong(arg);
32 33 34 35
    } else {
        PyObject *index = PyNumber_Index(arg);
        if (index == NULL) {
            PyErr_Format(PyExc_TypeError, "an integer is required");
36
            *value = -1;
37 38
            return 0;
        }
39 40 41 42 43 44 45
        face_value = PyLong_AsLong(index);
        Py_DECREF(index);
    }

    if (face_value < 0 || face_value >= 256) {
        /* this includes the OverflowError in case the long is too large */
        PyErr_SetString(PyExc_ValueError, "byte must be in range(0, 256)");
46
        *value = -1;
47 48 49 50 51 52 53 54
        return 0;
    }

    *value = face_value;
    return 1;
}

static int
55
bytearray_getbuffer(PyByteArrayObject *obj, Py_buffer *view, int flags)
56 57 58 59 60 61 62
{
    int ret;
    void *ptr;
    if (view == NULL) {
        obj->ob_exports++;
        return 0;
    }
63
    ptr = (void *) PyByteArray_AS_STRING(obj);
64
    ret = PyBuffer_FillInfo(view, (PyObject*)obj, ptr, Py_SIZE(obj), 0, flags);
65 66 67 68 69 70 71
    if (ret >= 0) {
        obj->ob_exports++;
    }
    return ret;
}

static void
72
bytearray_releasebuffer(PyByteArrayObject *obj, Py_buffer *view)
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
{
    obj->ob_exports--;
}

static Py_ssize_t
_getbuffer(PyObject *obj, Py_buffer *view)
{
    PyBufferProcs *buffer = Py_TYPE(obj)->tp_as_buffer;

    if (buffer == NULL || buffer->bf_getbuffer == NULL)
    {
        PyErr_Format(PyExc_TypeError,
                     "Type %.100s doesn't support the buffer API",
                     Py_TYPE(obj)->tp_name);
        return -1;
    }

    if (buffer->bf_getbuffer(obj, view, PyBUF_SIMPLE) < 0)
            return -1;
    return view->len;
}

95 96 97 98 99 100 101 102 103 104 105
static int
_canresize(PyByteArrayObject *self)
{
    if (self->ob_exports > 0) {
        PyErr_SetString(PyExc_BufferError,
                "Existing exports of data: object cannot be re-sized");
        return 0;
    }
    return 1;
}

106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
/* Direct API functions */

PyObject *
PyByteArray_FromObject(PyObject *input)
{
    return PyObject_CallFunctionObjArgs((PyObject *)&PyByteArray_Type,
                                        input, NULL);
}

PyObject *
PyByteArray_FromStringAndSize(const char *bytes, Py_ssize_t size)
{
    PyByteArrayObject *new;
    Py_ssize_t alloc;

    if (size < 0) {
        PyErr_SetString(PyExc_SystemError,
            "Negative size passed to PyByteArray_FromStringAndSize");
        return NULL;
    }

127 128 129 130 131
    /* Prevent buffer overflow when setting alloc to size+1. */
    if (size == PY_SSIZE_T_MAX) {
        return PyErr_NoMemory();
    }

132 133 134 135 136 137 138 139 140 141
    new = PyObject_New(PyByteArrayObject, &PyByteArray_Type);
    if (new == NULL)
        return NULL;

    if (size == 0) {
        new->ob_bytes = NULL;
        alloc = 0;
    }
    else {
        alloc = size + 1;
142
        new->ob_bytes = PyObject_Malloc(alloc);
143 144 145 146
        if (new->ob_bytes == NULL) {
            Py_DECREF(new);
            return PyErr_NoMemory();
        }
147
        if (bytes != NULL && size > 0)
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
            memcpy(new->ob_bytes, bytes, size);
        new->ob_bytes[size] = '\0';  /* Trailing null byte */
    }
    Py_SIZE(new) = size;
    new->ob_alloc = alloc;
    new->ob_exports = 0;

    return (PyObject *)new;
}

Py_ssize_t
PyByteArray_Size(PyObject *self)
{
    assert(self != NULL);
    assert(PyByteArray_Check(self));

    return PyByteArray_GET_SIZE(self);
}

char  *
PyByteArray_AsString(PyObject *self)
{
    assert(self != NULL);
    assert(PyByteArray_Check(self));

    return PyByteArray_AS_STRING(self);
}

int
PyByteArray_Resize(PyObject *self, Py_ssize_t size)
{
    void *sval;
    Py_ssize_t alloc = ((PyByteArrayObject *)self)->ob_alloc;

    assert(self != NULL);
    assert(PyByteArray_Check(self));
    assert(size >= 0);

186 187 188 189 190 191 192
    if (size == Py_SIZE(self)) {
        return 0;
    }
    if (!_canresize((PyByteArrayObject *)self)) {
        return -1;
    }

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
    if (size < alloc / 2) {
        /* Major downsize; resize down to exact size */
        alloc = size + 1;
    }
    else if (size < alloc) {
        /* Within allocated size; quick exit */
        Py_SIZE(self) = size;
        ((PyByteArrayObject *)self)->ob_bytes[size] = '\0'; /* Trailing null */
        return 0;
    }
    else if (size <= alloc * 1.125) {
        /* Moderate upsize; overallocate similar to list_resize() */
        alloc = size + (size >> 3) + (size < 9 ? 3 : 6);
    }
    else {
        /* Major upsize; resize up to exact size */
        alloc = size + 1;
    }

212
    sval = PyObject_Realloc(((PyByteArrayObject *)self)->ob_bytes, alloc);
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
    if (sval == NULL) {
        PyErr_NoMemory();
        return -1;
    }

    ((PyByteArrayObject *)self)->ob_bytes = sval;
    Py_SIZE(self) = size;
    ((PyByteArrayObject *)self)->ob_alloc = alloc;
    ((PyByteArrayObject *)self)->ob_bytes[size] = '\0'; /* Trailing null byte */

    return 0;
}

PyObject *
PyByteArray_Concat(PyObject *a, PyObject *b)
{
    Py_ssize_t size;
    Py_buffer va, vb;
    PyByteArrayObject *result = NULL;

    va.len = -1;
    vb.len = -1;
    if (_getbuffer(a, &va) < 0  ||
        _getbuffer(b, &vb) < 0) {
            PyErr_Format(PyExc_TypeError, "can't concat %.100s to %.100s",
                         Py_TYPE(a)->tp_name, Py_TYPE(b)->tp_name);
            goto done;
    }

    size = va.len + vb.len;
    if (size < 0) {
Benjamin Peterson's avatar
Benjamin Peterson committed
244
            PyErr_NoMemory();
245 246 247 248 249 250 251 252 253 254 255
            goto done;
    }

    result = (PyByteArrayObject *) PyByteArray_FromStringAndSize(NULL, size);
    if (result != NULL) {
        memcpy(result->ob_bytes, va.buf, va.len);
        memcpy(result->ob_bytes + va.len, vb.buf, vb.len);
    }

  done:
    if (va.len != -1)
256
        PyBuffer_Release(&va);
257
    if (vb.len != -1)
258
        PyBuffer_Release(&vb);
259 260 261 262 263 264
    return (PyObject *)result;
}

/* Functions stuffed into the type object */

static Py_ssize_t
265
bytearray_length(PyByteArrayObject *self)
266 267 268 269 270
{
    return Py_SIZE(self);
}

static PyObject *
271
bytearray_iconcat(PyByteArrayObject *self, PyObject *other)
272 273 274 275 276 277 278 279 280 281 282 283 284 285
{
    Py_ssize_t mysize;
    Py_ssize_t size;
    Py_buffer vo;

    if (_getbuffer(other, &vo) < 0) {
        PyErr_Format(PyExc_TypeError, "can't concat %.100s to %.100s",
                     Py_TYPE(other)->tp_name, Py_TYPE(self)->tp_name);
        return NULL;
    }

    mysize = Py_SIZE(self);
    size = mysize + vo.len;
    if (size < 0) {
286
        PyBuffer_Release(&vo);
287 288 289 290 291 292 293
        return PyErr_NoMemory();
    }
    if (size < self->ob_alloc) {
        Py_SIZE(self) = size;
        self->ob_bytes[Py_SIZE(self)] = '\0'; /* Trailing null byte */
    }
    else if (PyByteArray_Resize((PyObject *)self, size) < 0) {
294
        PyBuffer_Release(&vo);
295 296 297
        return NULL;
    }
    memcpy(self->ob_bytes + mysize, vo.buf, vo.len);
298
    PyBuffer_Release(&vo);
299 300 301 302 303
    Py_INCREF(self);
    return (PyObject *)self;
}

static PyObject *
304
bytearray_repeat(PyByteArrayObject *self, Py_ssize_t count)
305 306 307 308 309 310 311 312
{
    PyByteArrayObject *result;
    Py_ssize_t mysize;
    Py_ssize_t size;

    if (count < 0)
        count = 0;
    mysize = Py_SIZE(self);
313
    if (count > 0 && mysize > PY_SSIZE_T_MAX / count)
314
        return PyErr_NoMemory();
315
    size = mysize * count;
316 317 318 319 320 321 322 323 324 325 326 327 328 329
    result = (PyByteArrayObject *)PyByteArray_FromStringAndSize(NULL, size);
    if (result != NULL && size != 0) {
        if (mysize == 1)
            memset(result->ob_bytes, self->ob_bytes[0], size);
        else {
            Py_ssize_t i;
            for (i = 0; i < count; i++)
                memcpy(result->ob_bytes + i*mysize, self->ob_bytes, mysize);
        }
    }
    return (PyObject *)result;
}

static PyObject *
330
bytearray_irepeat(PyByteArrayObject *self, Py_ssize_t count)
331 332 333 334 335 336 337
{
    Py_ssize_t mysize;
    Py_ssize_t size;

    if (count < 0)
        count = 0;
    mysize = Py_SIZE(self);
338
    if (count > 0 && mysize > PY_SSIZE_T_MAX / count)
339
        return PyErr_NoMemory();
340
    size = mysize * count;
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
    if (size < self->ob_alloc) {
        Py_SIZE(self) = size;
        self->ob_bytes[Py_SIZE(self)] = '\0'; /* Trailing null byte */
    }
    else if (PyByteArray_Resize((PyObject *)self, size) < 0)
        return NULL;

    if (mysize == 1)
        memset(self->ob_bytes, self->ob_bytes[0], size);
    else {
        Py_ssize_t i;
        for (i = 1; i < count; i++)
            memcpy(self->ob_bytes + i*mysize, self->ob_bytes, mysize);
    }

    Py_INCREF(self);
    return (PyObject *)self;
}

static PyObject *
361
bytearray_getitem(PyByteArrayObject *self, Py_ssize_t i)
362 363 364 365 366 367 368 369 370 371 372
{
    if (i < 0)
        i += Py_SIZE(self);
    if (i < 0 || i >= Py_SIZE(self)) {
        PyErr_SetString(PyExc_IndexError, "bytearray index out of range");
        return NULL;
    }
    return PyLong_FromLong((unsigned char)(self->ob_bytes[i]));
}

static PyObject *
373
bytearray_subscript(PyByteArrayObject *self, PyObject *index)
374
{
375 376
    if (PyIndex_Check(index)) {
        Py_ssize_t i = PyNumber_AsSsize_t(index, PyExc_IndexError);
377 378 379 380 381 382 383 384 385 386 387 388 389

        if (i == -1 && PyErr_Occurred())
            return NULL;

        if (i < 0)
            i += PyByteArray_GET_SIZE(self);

        if (i < 0 || i >= Py_SIZE(self)) {
            PyErr_SetString(PyExc_IndexError, "bytearray index out of range");
            return NULL;
        }
        return PyLong_FromLong((unsigned char)(self->ob_bytes[i]));
    }
390
    else if (PySlice_Check(index)) {
391
        Py_ssize_t start, stop, step, slicelength, cur, i;
392
        if (PySlice_GetIndicesEx(index,
393 394 395 396 397 398 399 400 401 402 403 404 405
                                 PyByteArray_GET_SIZE(self),
                                 &start, &stop, &step, &slicelength) < 0) {
            return NULL;
        }

        if (slicelength <= 0)
            return PyByteArray_FromStringAndSize("", 0);
        else if (step == 1) {
            return PyByteArray_FromStringAndSize(self->ob_bytes + start,
                                             slicelength);
        }
        else {
            char *source_buf = PyByteArray_AS_STRING(self);
406
            char *result_buf;
407 408
            PyObject *result;

409 410 411
            result = PyByteArray_FromStringAndSize(NULL, slicelength);
            if (result == NULL)
                return NULL;
412

413
            result_buf = PyByteArray_AS_STRING(result);
414 415 416 417 418 419 420 421 422 423 424 425 426 427
            for (cur = start, i = 0; i < slicelength;
                 cur += step, i++) {
                     result_buf[i] = source_buf[cur];
            }
            return result;
        }
    }
    else {
        PyErr_SetString(PyExc_TypeError, "bytearray indices must be integers");
        return NULL;
    }
}

static int
428
bytearray_setslice(PyByteArrayObject *self, Py_ssize_t lo, Py_ssize_t hi,
429 430 431 432 433 434 435 436 437 438 439 440 441 442
               PyObject *values)
{
    Py_ssize_t avail, needed;
    void *bytes;
    Py_buffer vbytes;
    int res = 0;

    vbytes.len = -1;
    if (values == (PyObject *)self) {
        /* Make a copy and call this function recursively */
        int err;
        values = PyByteArray_FromObject(values);
        if (values == NULL)
            return -1;
443
        err = bytearray_setslice(self, lo, hi, values);
444 445 446 447 448 449 450 451 452 453 454
        Py_DECREF(values);
        return err;
    }
    if (values == NULL) {
        /* del b[lo:hi] */
        bytes = NULL;
        needed = 0;
    }
    else {
            if (_getbuffer(values, &vbytes) < 0) {
                    PyErr_Format(PyExc_TypeError,
Georg Brandl's avatar
Georg Brandl committed
455
                                 "can't set bytearray slice from %.100s",
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
                                 Py_TYPE(values)->tp_name);
                    return -1;
            }
            needed = vbytes.len;
            bytes = vbytes.buf;
    }

    if (lo < 0)
        lo = 0;
    if (hi < lo)
        hi = lo;
    if (hi > Py_SIZE(self))
        hi = Py_SIZE(self);

    avail = hi - lo;
    if (avail < 0)
        lo = hi = avail = 0;

    if (avail != needed) {
        if (avail > needed) {
476 477 478 479
            if (!_canresize(self)) {
                res = -1;
                goto finish;
            }
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
            /*
              0   lo               hi               old_size
              |   |<----avail----->|<-----tomove------>|
              |   |<-needed->|<-----tomove------>|
              0   lo      new_hi              new_size
            */
            memmove(self->ob_bytes + lo + needed, self->ob_bytes + hi,
                    Py_SIZE(self) - hi);
        }
        /* XXX(nnorwitz): need to verify this can't overflow! */
        if (PyByteArray_Resize((PyObject *)self,
                           Py_SIZE(self) + needed - avail) < 0) {
                res = -1;
                goto finish;
        }
        if (avail < needed) {
            /*
              0   lo        hi               old_size
              |   |<-avail->|<-----tomove------>|
              |   |<----needed---->|<-----tomove------>|
              0   lo            new_hi              new_size
             */
            memmove(self->ob_bytes + lo + needed, self->ob_bytes + hi,
                    Py_SIZE(self) - lo - needed);
        }
    }

    if (needed > 0)
        memcpy(self->ob_bytes + lo, bytes, needed);


 finish:
    if (vbytes.len != -1)
513
            PyBuffer_Release(&vbytes);
514 515 516 517
    return res;
}

static int
518
bytearray_setitem(PyByteArrayObject *self, Py_ssize_t i, PyObject *value)
519
{
520
    int ival;
521 522 523 524 525 526 527 528 529 530

    if (i < 0)
        i += Py_SIZE(self);

    if (i < 0 || i >= Py_SIZE(self)) {
        PyErr_SetString(PyExc_IndexError, "bytearray index out of range");
        return -1;
    }

    if (value == NULL)
531
        return bytearray_setslice(self, i, i+1, NULL);
532

533
    if (!_getbytevalue(value, &ival))
534 535 536 537 538 539 540
        return -1;

    self->ob_bytes[i] = ival;
    return 0;
}

static int
541
bytearray_ass_subscript(PyByteArrayObject *self, PyObject *index, PyObject *values)
542 543 544 545
{
    Py_ssize_t start, stop, step, slicelen, needed;
    char *bytes;

546 547
    if (PyIndex_Check(index)) {
        Py_ssize_t i = PyNumber_AsSsize_t(index, PyExc_IndexError);
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567

        if (i == -1 && PyErr_Occurred())
            return -1;

        if (i < 0)
            i += PyByteArray_GET_SIZE(self);

        if (i < 0 || i >= Py_SIZE(self)) {
            PyErr_SetString(PyExc_IndexError, "bytearray index out of range");
            return -1;
        }

        if (values == NULL) {
            /* Fall through to slice assignment */
            start = i;
            stop = i + 1;
            step = 1;
            slicelen = 1;
        }
        else {
568 569
            int ival;
            if (!_getbytevalue(values, &ival))
570 571 572 573 574
                return -1;
            self->ob_bytes[i] = (char)ival;
            return 0;
        }
    }
575
    else if (PySlice_Check(index)) {
576
        if (PySlice_GetIndicesEx(index,
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
                                 PyByteArray_GET_SIZE(self),
                                 &start, &stop, &step, &slicelen) < 0) {
            return -1;
        }
    }
    else {
        PyErr_SetString(PyExc_TypeError, "bytearray indices must be integer");
        return -1;
    }

    if (values == NULL) {
        bytes = NULL;
        needed = 0;
    }
    else if (values == (PyObject *)self || !PyByteArray_Check(values)) {
Georg Brandl's avatar
Georg Brandl committed
592
        /* Make a copy and call this function recursively */
593 594 595 596
        int err;
        values = PyByteArray_FromObject(values);
        if (values == NULL)
            return -1;
597
        err = bytearray_ass_subscript(self, index, values);
598 599 600 601 602 603 604 605 606 607 608 609 610 611
        Py_DECREF(values);
        return err;
    }
    else {
        assert(PyByteArray_Check(values));
        bytes = ((PyByteArrayObject *)values)->ob_bytes;
        needed = Py_SIZE(values);
    }
    /* Make sure b[5:2] = ... inserts before 5, not before 2. */
    if ((step < 0 && start < stop) ||
        (step > 0 && start > stop))
        stop = start;
    if (step == 1) {
        if (slicelen != needed) {
612 613
            if (!_canresize(self))
                return -1;
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
            if (slicelen > needed) {
                /*
                  0   start           stop              old_size
                  |   |<---slicelen--->|<-----tomove------>|
                  |   |<-needed->|<-----tomove------>|
                  0   lo      new_hi              new_size
                */
                memmove(self->ob_bytes + start + needed, self->ob_bytes + stop,
                        Py_SIZE(self) - stop);
            }
            if (PyByteArray_Resize((PyObject *)self,
                               Py_SIZE(self) + needed - slicelen) < 0)
                return -1;
            if (slicelen < needed) {
                /*
                  0   lo        hi               old_size
                  |   |<-avail->|<-----tomove------>|
                  |   |<----needed---->|<-----tomove------>|
                  0   lo            new_hi              new_size
                 */
                memmove(self->ob_bytes + start + needed, self->ob_bytes + stop,
                        Py_SIZE(self) - start - needed);
            }
        }

        if (needed > 0)
            memcpy(self->ob_bytes + start, bytes, needed);

        return 0;
    }
    else {
        if (needed == 0) {
            /* Delete slice */
647 648
            size_t cur;
            Py_ssize_t i;
649

650 651
            if (!_canresize(self))
                return -1;
652 653 654 655 656

            if (slicelen == 0)
                /* Nothing to do here. */
                return 0;

657 658 659 660 661 662 663 664 665
            if (step < 0) {
                stop = start + 1;
                start = stop + step * (slicelen - 1) - 1;
                step = -step;
            }
            for (cur = start, i = 0;
                 i < slicelen; cur += step, i++) {
                Py_ssize_t lim = step - 1;

666
                if (cur + step >= (size_t)PyByteArray_GET_SIZE(self))
667 668 669 670 671 672
                    lim = PyByteArray_GET_SIZE(self) - cur - 1;

                memmove(self->ob_bytes + cur - i,
                        self->ob_bytes + cur + 1, lim);
            }
            /* Move the tail of the bytes, in one chunk */
673
            cur = start + (size_t)slicelen*step;
674
            if (cur < (size_t)PyByteArray_GET_SIZE(self)) {
675 676 677 678 679 680 681 682 683 684 685 686
                memmove(self->ob_bytes + cur - slicelen,
                        self->ob_bytes + cur,
                        PyByteArray_GET_SIZE(self) - cur);
            }
            if (PyByteArray_Resize((PyObject *)self,
                               PyByteArray_GET_SIZE(self) - slicelen) < 0)
                return -1;

            return 0;
        }
        else {
            /* Assign slice */
687 688
            Py_ssize_t i;
            size_t cur;
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704

            if (needed != slicelen) {
                PyErr_Format(PyExc_ValueError,
                             "attempt to assign bytes of size %zd "
                             "to extended slice of size %zd",
                             needed, slicelen);
                return -1;
            }
            for (cur = start, i = 0; i < slicelen; cur += step, i++)
                self->ob_bytes[cur] = bytes[i];
            return 0;
        }
    }
}

static int
705
bytearray_init(PyByteArrayObject *self, PyObject *args, PyObject *kwds)
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
{
    static char *kwlist[] = {"source", "encoding", "errors", 0};
    PyObject *arg = NULL;
    const char *encoding = NULL;
    const char *errors = NULL;
    Py_ssize_t count;
    PyObject *it;
    PyObject *(*iternext)(PyObject *);

    if (Py_SIZE(self) != 0) {
        /* Empty previous contents (yes, do this first of all!) */
        if (PyByteArray_Resize((PyObject *)self, 0) < 0)
            return -1;
    }

    /* Parse arguments */
Georg Brandl's avatar
Georg Brandl committed
722
    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oss:bytearray", kwlist,
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
                                     &arg, &encoding, &errors))
        return -1;

    /* Make a quick exit if no first argument */
    if (arg == NULL) {
        if (encoding != NULL || errors != NULL) {
            PyErr_SetString(PyExc_TypeError,
                            "encoding or errors without sequence argument");
            return -1;
        }
        return 0;
    }

    if (PyUnicode_Check(arg)) {
        /* Encode via the codec registry */
        PyObject *encoded, *new;
        if (encoding == NULL) {
            PyErr_SetString(PyExc_TypeError,
                            "string argument without an encoding");
            return -1;
        }
744
        encoded = PyUnicode_AsEncodedString(arg, encoding, errors);
745 746 747
        if (encoded == NULL)
            return -1;
        assert(PyBytes_Check(encoded));
748
        new = bytearray_iconcat(self, encoded);
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
        Py_DECREF(encoded);
        if (new == NULL)
            return -1;
        Py_DECREF(new);
        return 0;
    }

    /* If it's not unicode, there can't be encoding or errors */
    if (encoding != NULL || errors != NULL) {
        PyErr_SetString(PyExc_TypeError,
                        "encoding or errors without a string argument");
        return -1;
    }

    /* Is it an int? */
764 765 766
    count = PyNumber_AsSsize_t(arg, PyExc_OverflowError);
    if (count == -1 && PyErr_Occurred()) {
        if (PyErr_ExceptionMatches(PyExc_OverflowError))
767
            return -1;
768
        PyErr_Clear();
769 770 771 772 773 774
    }
    else if (count < 0) {
        PyErr_SetString(PyExc_ValueError, "negative count");
        return -1;
    }
    else {
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
        if (count > 0) {
            if (PyByteArray_Resize((PyObject *)self, count))
                return -1;
            memset(self->ob_bytes, 0, count);
        }
        return 0;
    }

    /* Use the buffer API */
    if (PyObject_CheckBuffer(arg)) {
        Py_ssize_t size;
        Py_buffer view;
        if (PyObject_GetBuffer(arg, &view, PyBUF_FULL_RO) < 0)
            return -1;
        size = view.len;
        if (PyByteArray_Resize((PyObject *)self, size) < 0) goto fail;
        if (PyBuffer_ToContiguous(self->ob_bytes, &view, size, 'C') < 0)
792
            goto fail;
793
        PyBuffer_Release(&view);
794 795
        return 0;
    fail:
796
        PyBuffer_Release(&view);
797 798 799 800 801 802 803 804 805 806 807 808 809 810
        return -1;
    }

    /* XXX Optimize this if the arguments is a list, tuple */

    /* Get the iterator */
    it = PyObject_GetIter(arg);
    if (it == NULL)
        return -1;
    iternext = *Py_TYPE(it)->tp_iternext;

    /* Run the iterator to exhaustion */
    for (;;) {
        PyObject *item;
811
        int rc, value;
812 813 814 815 816 817 818 819 820 821 822 823 824

        /* Get the next item */
        item = iternext(it);
        if (item == NULL) {
            if (PyErr_Occurred()) {
                if (!PyErr_ExceptionMatches(PyExc_StopIteration))
                    goto error;
                PyErr_Clear();
            }
            break;
        }

        /* Interpret it as an int (__index__) */
825
        rc = _getbytevalue(item, &value);
826
        Py_DECREF(item);
827
        if (!rc)
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
            goto error;

        /* Append the byte */
        if (Py_SIZE(self) < self->ob_alloc)
            Py_SIZE(self)++;
        else if (PyByteArray_Resize((PyObject *)self, Py_SIZE(self)+1) < 0)
            goto error;
        self->ob_bytes[Py_SIZE(self)-1] = value;
    }

    /* Clean up and return success */
    Py_DECREF(it);
    return 0;

 error:
    /* Error handling when it != NULL */
    Py_DECREF(it);
    return -1;
}

/* Mostly copied from string_repr, but without the
   "smart quote" functionality. */
static PyObject *
851
bytearray_repr(PyByteArrayObject *self)
852 853 854 855
{
    const char *quote_prefix = "bytearray(b";
    const char *quote_postfix = ")";
    Py_ssize_t length = Py_SIZE(self);
Martin v. Löwis's avatar
Martin v. Löwis committed
856
    /* 15 == strlen(quote_prefix) + 2 + strlen(quote_postfix) + 1 */
857
    size_t newsize;
858
    PyObject *v;
Martin v. Löwis's avatar
Martin v. Löwis committed
859 860 861 862 863 864 865 866
    register Py_ssize_t i;
    register char c;
    register char *p;
    int quote;
    char *test, *start;
    char *buffer;

    if (length > (PY_SSIZE_T_MAX - 15) / 4) {
867 868 869 870
        PyErr_SetString(PyExc_OverflowError,
            "bytearray object is too large to make repr");
        return NULL;
    }
Martin v. Löwis's avatar
Martin v. Löwis committed
871 872

    newsize = 15 + length * 4;
873
    buffer = PyObject_Malloc(newsize);
Martin v. Löwis's avatar
Martin v. Löwis committed
874 875
    if (buffer == NULL) {
        PyErr_NoMemory();
876 877 878
        return NULL;
    }

Martin v. Löwis's avatar
Martin v. Löwis committed
879 880 881 882 883 884 885
    /* Figure out which quote to use; single is preferred */
    quote = '\'';
    start = PyByteArray_AS_STRING(self);
    for (test = start; test < start+length; ++test) {
        if (*test == '"') {
            quote = '\''; /* back to single */
            break;
886
        }
Martin v. Löwis's avatar
Martin v. Löwis committed
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
        else if (*test == '\'')
            quote = '"';
    }

    p = buffer;
    while (*quote_prefix)
        *p++ = *quote_prefix++;
    *p++ = quote;

    for (i = 0; i < length; i++) {
        /* There's at least enough room for a hex escape
           and a closing quote. */
        assert(newsize - (p - buffer) >= 5);
        c = self->ob_bytes[i];
        if (c == '\'' || c == '\\')
            *p++ = '\\', *p++ = c;
        else if (c == '\t')
            *p++ = '\\', *p++ = 't';
        else if (c == '\n')
            *p++ = '\\', *p++ = 'n';
        else if (c == '\r')
            *p++ = '\\', *p++ = 'r';
        else if (c == 0)
            *p++ = '\\', *p++ = 'x', *p++ = '0', *p++ = '0';
        else if (c < ' ' || c >= 0x7f) {
            *p++ = '\\';
            *p++ = 'x';
914 915
            *p++ = Py_hexdigits[(c & 0xf0) >> 4];
            *p++ = Py_hexdigits[c & 0xf];
916
        }
Martin v. Löwis's avatar
Martin v. Löwis committed
917 918 919 920 921 922 923
        else
            *p++ = c;
    }
    assert(newsize - (p - buffer) >= 1);
    *p++ = quote;
    while (*quote_postfix) {
       *p++ = *quote_postfix++;
924
    }
Martin v. Löwis's avatar
Martin v. Löwis committed
925 926

    v = PyUnicode_DecodeASCII(buffer, p - buffer, NULL);
927
    PyObject_Free(buffer);
Martin v. Löwis's avatar
Martin v. Löwis committed
928
    return v;
929 930 931
}

static PyObject *
932
bytearray_str(PyObject *op)
933
{
934 935 936 937 938 939
        if (Py_BytesWarningFlag) {
                if (PyErr_WarnEx(PyExc_BytesWarning,
                                 "str() on a bytearray instance", 1))
                        return NULL;
        }
        return bytearray_repr((PyByteArrayObject*)op);
940 941 942
}

static PyObject *
943
bytearray_richcompare(PyObject *self, PyObject *other, int op)
944 945 946 947 948 949 950 951 952 953 954 955
{
    Py_ssize_t self_size, other_size;
    Py_buffer self_bytes, other_bytes;
    PyObject *res;
    Py_ssize_t minsize;
    int cmp;

    /* Bytes can be compared to anything that supports the (binary)
       buffer API.  Except that a comparison with Unicode is always an
       error, even if the comparison is for equality. */
    if (PyObject_IsInstance(self, (PyObject*)&PyUnicode_Type) ||
        PyObject_IsInstance(other, (PyObject*)&PyUnicode_Type)) {
956
        if (Py_BytesWarningFlag && (op == Py_EQ || op == Py_NE)) {
957
            if (PyErr_WarnEx(PyExc_BytesWarning,
Georg Brandl's avatar
Georg Brandl committed
958
                            "Comparison between bytearray and string", 1))
959 960 961
                return NULL;
        }

962
        Py_RETURN_NOTIMPLEMENTED;
963 964 965 966 967
    }

    self_size = _getbuffer(self, &self_bytes);
    if (self_size < 0) {
        PyErr_Clear();
968
        Py_RETURN_NOTIMPLEMENTED;
969 970 971 972 973
    }

    other_size = _getbuffer(other, &other_bytes);
    if (other_size < 0) {
        PyErr_Clear();
974
        PyBuffer_Release(&self_bytes);
975
        Py_RETURN_NOTIMPLEMENTED;
976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
    }

    if (self_size != other_size && (op == Py_EQ || op == Py_NE)) {
        /* Shortcut: if the lengths differ, the objects differ */
        cmp = (op == Py_NE);
    }
    else {
        minsize = self_size;
        if (other_size < minsize)
            minsize = other_size;

        cmp = memcmp(self_bytes.buf, other_bytes.buf, minsize);
        /* In ISO C, memcmp() guarantees to use unsigned bytes! */

        if (cmp == 0) {
            if (self_size < other_size)
                cmp = -1;
            else if (self_size > other_size)
                cmp = 1;
        }

        switch (op) {
        case Py_LT: cmp = cmp <  0; break;
        case Py_LE: cmp = cmp <= 0; break;
        case Py_EQ: cmp = cmp == 0; break;
        case Py_NE: cmp = cmp != 0; break;
        case Py_GT: cmp = cmp >  0; break;
        case Py_GE: cmp = cmp >= 0; break;
        }
    }

    res = cmp ? Py_True : Py_False;
1008 1009
    PyBuffer_Release(&self_bytes);
    PyBuffer_Release(&other_bytes);
1010 1011 1012 1013 1014
    Py_INCREF(res);
    return res;
}

static void
1015
bytearray_dealloc(PyByteArrayObject *self)
1016
{
Benjamin Peterson's avatar
Benjamin Peterson committed
1017 1018
    if (self->ob_exports > 0) {
        PyErr_SetString(PyExc_SystemError,
Benjamin Peterson's avatar
Benjamin Peterson committed
1019
                        "deallocated bytearray object has exported buffers");
Benjamin Peterson's avatar
Benjamin Peterson committed
1020 1021
        PyErr_Print();
    }
1022
    if (self->ob_bytes != 0) {
1023
        PyObject_Free(self->ob_bytes);
1024 1025 1026 1027 1028 1029 1030 1031
    }
    Py_TYPE(self)->tp_free((PyObject *)self);
}


/* -------------------------------------------------------------------- */
/* Methods */

Martin v. Löwis's avatar
Martin v. Löwis committed
1032 1033
#define FASTSEARCH fastsearch
#define STRINGLIB(F) stringlib_##F
1034 1035 1036 1037
#define STRINGLIB_CHAR char
#define STRINGLIB_LEN PyByteArray_GET_SIZE
#define STRINGLIB_STR PyByteArray_AS_STRING
#define STRINGLIB_NEW PyByteArray_FromStringAndSize
1038 1039
#define STRINGLIB_ISSPACE Py_ISSPACE
#define STRINGLIB_ISLINEBREAK(x) ((x == '\n') || (x == '\r'))
1040 1041 1042 1043 1044 1045 1046
#define STRINGLIB_CHECK_EXACT PyByteArray_CheckExact
#define STRINGLIB_MUTABLE 1

#include "stringlib/fastsearch.h"
#include "stringlib/count.h"
#include "stringlib/find.h"
#include "stringlib/partition.h"
1047
#include "stringlib/split.h"
1048 1049 1050 1051 1052 1053 1054
#include "stringlib/ctype.h"
#include "stringlib/transmogrify.h"


/* The following Py_LOCAL_INLINE and Py_LOCAL functions
were copied from the old char* style string object. */

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
/* helper macro to fixup start/end slice values */
#define ADJUST_INDICES(start, end, len)         \
    if (end > len)                              \
        end = len;                              \
    else if (end < 0) {                         \
        end += len;                             \
        if (end < 0)                            \
            end = 0;                            \
    }                                           \
    if (start < 0) {                            \
        start += len;                           \
        if (start < 0)                          \
            start = 0;                          \
    }
1069 1070

Py_LOCAL_INLINE(Py_ssize_t)
1071
bytearray_find_internal(PyByteArrayObject *self, PyObject *args, int dir)
1072 1073
{
    PyObject *subobj;
1074
    char byte;
1075
    Py_buffer subbuf;
1076 1077
    const char *sub;
    Py_ssize_t sub_len;
1078 1079 1080
    Py_ssize_t start=0, end=PY_SSIZE_T_MAX;
    Py_ssize_t res;

1081 1082
    if (!stringlib_parse_args_finds_byte("find/rfind/index/rindex",
                                         args, &subobj, &byte, &start, &end))
1083
        return -2;
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096

    if (subobj) {
        if (_getbuffer(subobj, &subbuf) < 0)
            return -2;

        sub = subbuf.buf;
        sub_len = subbuf.len;
    }
    else {
        sub = &byte;
        sub_len = 1;
    }

1097 1098 1099
    if (dir > 0)
        res = stringlib_find_slice(
            PyByteArray_AS_STRING(self), PyByteArray_GET_SIZE(self),
1100
            sub, sub_len, start, end);
1101 1102 1103
    else
        res = stringlib_rfind_slice(
            PyByteArray_AS_STRING(self), PyByteArray_GET_SIZE(self),
1104 1105 1106 1107 1108
            sub, sub_len, start, end);

    if (subobj)
        PyBuffer_Release(&subbuf);

1109 1110 1111 1112
    return res;
}

PyDoc_STRVAR(find__doc__,
1113
"B.find(sub[, start[, end]]) -> int\n\
1114 1115
\n\
Return the lowest index in B where subsection sub is found,\n\
1116
such that sub is contained within B[start,end].  Optional\n\
1117 1118 1119 1120 1121
arguments start and end are interpreted as in slice notation.\n\
\n\
Return -1 on failure.");

static PyObject *
1122
bytearray_find(PyByteArrayObject *self, PyObject *args)
1123
{
1124
    Py_ssize_t result = bytearray_find_internal(self, args, +1);
1125 1126 1127 1128 1129 1130
    if (result == -2)
        return NULL;
    return PyLong_FromSsize_t(result);
}

PyDoc_STRVAR(count__doc__,
1131
"B.count(sub[, start[, end]]) -> int\n\
1132 1133 1134 1135 1136 1137
\n\
Return the number of non-overlapping occurrences of subsection sub in\n\
bytes B[start:end].  Optional arguments start and end are interpreted\n\
as in slice notation.");

static PyObject *
1138
bytearray_count(PyByteArrayObject *self, PyObject *args)
1139 1140
{
    PyObject *sub_obj;
1141 1142 1143
    const char *str = PyByteArray_AS_STRING(self), *sub;
    Py_ssize_t sub_len;
    char byte;
1144
    Py_ssize_t start = 0, end = PY_SSIZE_T_MAX;
1145

1146 1147 1148
    Py_buffer vsub;
    PyObject *count_obj;

1149 1150
    if (!stringlib_parse_args_finds_byte("count", args, &sub_obj, &byte,
                                         &start, &end))
1151 1152
        return NULL;

1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
    if (sub_obj) {
        if (_getbuffer(sub_obj, &vsub) < 0)
            return NULL;

        sub = vsub.buf;
        sub_len = vsub.len;
    }
    else {
        sub = &byte;
        sub_len = 1;
    }
1164

1165
    ADJUST_INDICES(start, end, PyByteArray_GET_SIZE(self));
1166 1167

    count_obj = PyLong_FromSsize_t(
1168
        stringlib_count(str + start, end - start, sub, sub_len, PY_SSIZE_T_MAX)
1169
        );
1170 1171 1172 1173

    if (sub_obj)
        PyBuffer_Release(&vsub);

1174 1175 1176
    return count_obj;
}

1177 1178 1179 1180 1181
PyDoc_STRVAR(clear__doc__,
"B.clear() -> None\n\
\n\
Remove all items from B.");

1182
static PyObject *
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
bytearray_clear(PyByteArrayObject *self)
{
    if (PyByteArray_Resize((PyObject *)self, 0) < 0)
        return NULL;
    Py_RETURN_NONE;
}

PyDoc_STRVAR(copy__doc__,
"B.copy() -> bytearray\n\
\n\
Return a copy of B.");

static PyObject *
bytearray_copy(PyByteArrayObject *self)
{
    return PyByteArray_FromStringAndSize(PyByteArray_AS_STRING((PyObject *)self),
                                         PyByteArray_GET_SIZE(self));
}
1201 1202

PyDoc_STRVAR(index__doc__,
1203
"B.index(sub[, start[, end]]) -> int\n\
1204 1205 1206 1207
\n\
Like B.find() but raise ValueError when the subsection is not found.");

static PyObject *
1208
bytearray_index(PyByteArrayObject *self, PyObject *args)
1209
{
1210
    Py_ssize_t result = bytearray_find_internal(self, args, +1);
1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
    if (result == -2)
        return NULL;
    if (result == -1) {
        PyErr_SetString(PyExc_ValueError,
                        "subsection not found");
        return NULL;
    }
    return PyLong_FromSsize_t(result);
}


PyDoc_STRVAR(rfind__doc__,
1223
"B.rfind(sub[, start[, end]]) -> int\n\
1224 1225
\n\
Return the highest index in B where subsection sub is found,\n\
1226
such that sub is contained within B[start,end].  Optional\n\
1227 1228 1229 1230 1231
arguments start and end are interpreted as in slice notation.\n\
\n\
Return -1 on failure.");

static PyObject *
1232
bytearray_rfind(PyByteArrayObject *self, PyObject *args)
1233
{
1234
    Py_ssize_t result = bytearray_find_internal(self, args, -1);
1235 1236 1237 1238 1239 1240 1241
    if (result == -2)
        return NULL;
    return PyLong_FromSsize_t(result);
}


PyDoc_STRVAR(rindex__doc__,
1242
"B.rindex(sub[, start[, end]]) -> int\n\
1243 1244 1245 1246
\n\
Like B.rfind() but raise ValueError when the subsection is not found.");

static PyObject *
1247
bytearray_rindex(PyByteArrayObject *self, PyObject *args)
1248
{
1249
    Py_ssize_t result = bytearray_find_internal(self, args, -1);
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
    if (result == -2)
        return NULL;
    if (result == -1) {
        PyErr_SetString(PyExc_ValueError,
                        "subsection not found");
        return NULL;
    }
    return PyLong_FromSsize_t(result);
}


static int
1262
bytearray_contains(PyObject *self, PyObject *arg)
1263 1264 1265 1266
{
    Py_ssize_t ival = PyNumber_AsSsize_t(arg, PyExc_ValueError);
    if (ival == -1 && PyErr_Occurred()) {
        Py_buffer varg;
1267
        Py_ssize_t pos;
1268 1269 1270 1271 1272
        PyErr_Clear();
        if (_getbuffer(arg, &varg) < 0)
            return -1;
        pos = stringlib_find(PyByteArray_AS_STRING(self), Py_SIZE(self),
                             varg.buf, varg.len, 0);
1273
        PyBuffer_Release(&varg);
1274 1275 1276 1277 1278 1279 1280
        return pos >= 0;
    }
    if (ival < 0 || ival >= 256) {
        PyErr_SetString(PyExc_ValueError, "byte must be in range(0, 256)");
        return -1;
    }

1281
    return memchr(PyByteArray_AS_STRING(self), (int) ival, Py_SIZE(self)) != NULL;
1282 1283 1284 1285 1286 1287 1288 1289
}


/* Matches the end (direction >= 0) or start (direction < 0) of self
 * against substr, using the start and end arguments. Returns
 * -1 on error, 0 if not found and 1 if found.
 */
Py_LOCAL(int)
1290
_bytearray_tailmatch(PyByteArrayObject *self, PyObject *substr, Py_ssize_t start,
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302
                 Py_ssize_t end, int direction)
{
    Py_ssize_t len = PyByteArray_GET_SIZE(self);
    const char* str;
    Py_buffer vsubstr;
    int rv = 0;

    str = PyByteArray_AS_STRING(self);

    if (_getbuffer(substr, &vsubstr) < 0)
        return -1;

1303
    ADJUST_INDICES(start, end, len);
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322

    if (direction < 0) {
        /* startswith */
        if (start+vsubstr.len > len) {
            goto done;
        }
    } else {
        /* endswith */
        if (end-start < vsubstr.len || start > len) {
            goto done;
        }

        if (end-vsubstr.len > start)
            start = end - vsubstr.len;
    }
    if (end-start >= vsubstr.len)
        rv = ! memcmp(str+start, vsubstr.buf, vsubstr.len);

done:
1323
    PyBuffer_Release(&vsubstr);
1324 1325 1326 1327 1328
    return rv;
}


PyDoc_STRVAR(startswith__doc__,
1329
"B.startswith(prefix[, start[, end]]) -> bool\n\
1330 1331 1332 1333
\n\
Return True if B starts with the specified prefix, False otherwise.\n\
With optional start, test B beginning at that position.\n\
With optional end, stop comparing B at that position.\n\
1334
prefix can also be a tuple of bytes to try.");
1335 1336

static PyObject *
1337
bytearray_startswith(PyByteArrayObject *self, PyObject *args)
1338 1339 1340 1341 1342 1343
{
    Py_ssize_t start = 0;
    Py_ssize_t end = PY_SSIZE_T_MAX;
    PyObject *subobj;
    int result;

1344
    if (!stringlib_parse_args_finds("startswith", args, &subobj, &start, &end))
1345 1346 1347 1348
        return NULL;
    if (PyTuple_Check(subobj)) {
        Py_ssize_t i;
        for (i = 0; i < PyTuple_GET_SIZE(subobj); i++) {
1349
            result = _bytearray_tailmatch(self,
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
                                      PyTuple_GET_ITEM(subobj, i),
                                      start, end, -1);
            if (result == -1)
                return NULL;
            else if (result) {
                Py_RETURN_TRUE;
            }
        }
        Py_RETURN_FALSE;
    }
1360
    result = _bytearray_tailmatch(self, subobj, start, end, -1);
1361 1362 1363 1364
    if (result == -1) {
        if (PyErr_ExceptionMatches(PyExc_TypeError))
            PyErr_Format(PyExc_TypeError, "startswith first arg must be bytes "
                         "or a tuple of bytes, not %s", Py_TYPE(subobj)->tp_name);
1365
        return NULL;
1366
    }
1367 1368 1369 1370 1371
    else
        return PyBool_FromLong(result);
}

PyDoc_STRVAR(endswith__doc__,
1372
"B.endswith(suffix[, start[, end]]) -> bool\n\
1373 1374 1375 1376
\n\
Return True if B ends with the specified suffix, False otherwise.\n\
With optional start, test B beginning at that position.\n\
With optional end, stop comparing B at that position.\n\
1377
suffix can also be a tuple of bytes to try.");
1378 1379

static PyObject *
1380
bytearray_endswith(PyByteArrayObject *self, PyObject *args)
1381 1382 1383 1384 1385 1386
{
    Py_ssize_t start = 0;
    Py_ssize_t end = PY_SSIZE_T_MAX;
    PyObject *subobj;
    int result;

1387
    if (!stringlib_parse_args_finds("endswith", args, &subobj, &start, &end))
1388 1389 1390 1391
        return NULL;
    if (PyTuple_Check(subobj)) {
        Py_ssize_t i;
        for (i = 0; i < PyTuple_GET_SIZE(subobj); i++) {
1392
            result = _bytearray_tailmatch(self,
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
                                      PyTuple_GET_ITEM(subobj, i),
                                      start, end, +1);
            if (result == -1)
                return NULL;
            else if (result) {
                Py_RETURN_TRUE;
            }
        }
        Py_RETURN_FALSE;
    }
1403
    result = _bytearray_tailmatch(self, subobj, start, end, +1);
1404 1405 1406 1407
    if (result == -1) {
        if (PyErr_ExceptionMatches(PyExc_TypeError))
            PyErr_Format(PyExc_TypeError, "endswith first arg must be bytes or "
                         "a tuple of bytes, not %s", Py_TYPE(subobj)->tp_name);
1408
        return NULL;
1409
    }
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
    else
        return PyBool_FromLong(result);
}


PyDoc_STRVAR(translate__doc__,
"B.translate(table[, deletechars]) -> bytearray\n\
\n\
Return a copy of B, where all characters occurring in the\n\
optional argument deletechars are removed, and the remaining\n\
characters have been mapped through the given translation\n\
table, which must be a bytes object of length 256.");

static PyObject *
1424
bytearray_translate(PyByteArrayObject *self, PyObject *args)
1425 1426 1427
{
    register char *input, *output;
    register const char *table;
1428
    register Py_ssize_t i, c;
1429 1430 1431
    PyObject *input_obj = (PyObject*)self;
    const char *output_start;
    Py_ssize_t inlen;
1432
    PyObject *result = NULL;
1433
    int trans_table[256];
1434
    PyObject *tableobj = NULL, *delobj = NULL;
1435 1436 1437 1438 1439 1440
    Py_buffer vtable, vdel;

    if (!PyArg_UnpackTuple(args, "translate", 1, 2,
                           &tableobj, &delobj))
          return NULL;

1441 1442 1443 1444
    if (tableobj == Py_None) {
        table = NULL;
        tableobj = NULL;
    } else if (_getbuffer(tableobj, &vtable) < 0) {
1445
        return NULL;
1446 1447 1448 1449
    } else {
        if (vtable.len != 256) {
            PyErr_SetString(PyExc_ValueError,
                            "translation table must be 256 characters long");
1450 1451
            PyBuffer_Release(&vtable);
            return NULL;
1452 1453
        }
        table = (const char*)vtable.buf;
1454 1455 1456 1457
    }

    if (delobj != NULL) {
        if (_getbuffer(delobj, &vdel) < 0) {
1458 1459 1460
            if (tableobj != NULL)
                PyBuffer_Release(&vtable);
            return NULL;
1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
        }
    }
    else {
        vdel.buf = NULL;
        vdel.len = 0;
    }

    inlen = PyByteArray_GET_SIZE(input_obj);
    result = PyByteArray_FromStringAndSize((char *)NULL, inlen);
    if (result == NULL)
        goto done;
    output_start = output = PyByteArray_AsString(result);
    input = PyByteArray_AS_STRING(input_obj);

1475
    if (vdel.len == 0 && table != NULL) {
1476 1477 1478
        /* If no deletions are required, use faster code */
        for (i = inlen; --i >= 0; ) {
            c = Py_CHARMASK(*input++);
1479
            *output++ = table[c];
1480 1481 1482
        }
        goto done;
    }
1483 1484 1485 1486 1487 1488 1489 1490

    if (table == NULL) {
        for (i = 0; i < 256; i++)
            trans_table[i] = Py_CHARMASK(i);
    } else {
        for (i = 0; i < 256; i++)
            trans_table[i] = Py_CHARMASK(table[i]);
    }
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505

    for (i = 0; i < vdel.len; i++)
        trans_table[(int) Py_CHARMASK( ((unsigned char*)vdel.buf)[i] )] = -1;

    for (i = inlen; --i >= 0; ) {
        c = Py_CHARMASK(*input++);
        if (trans_table[c] != -1)
            if (Py_CHARMASK(*output++ = (char)trans_table[c]) == c)
                    continue;
    }
    /* Fix the size of the resulting string */
    if (inlen > 0)
        PyByteArray_Resize(result, output - output_start);

done:
1506 1507
    if (tableobj != NULL)
        PyBuffer_Release(&vtable);
1508
    if (delobj != NULL)
1509
        PyBuffer_Release(&vdel);
1510 1511 1512 1513
    return result;
}


1514
static PyObject *
1515
bytearray_maketrans(PyObject *null, PyObject *args)
1516
{
1517
        return _Py_bytes_maketrans(args);
1518 1519 1520
}


1521 1522 1523 1524 1525 1526
/* find and count characters and substrings */

#define findchar(target, target_len, c)                         \
  ((char *)memchr((const void *)(target), c, target_len))


1527
/* Bytes ops must return a string, create a copy */
1528 1529 1530
Py_LOCAL(PyByteArrayObject *)
return_self(PyByteArrayObject *self)
{
1531
    /* always return a new bytearray */
1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563
    return (PyByteArrayObject *)PyByteArray_FromStringAndSize(
            PyByteArray_AS_STRING(self),
            PyByteArray_GET_SIZE(self));
}

Py_LOCAL_INLINE(Py_ssize_t)
countchar(const char *target, Py_ssize_t target_len, char c, Py_ssize_t maxcount)
{
    Py_ssize_t count=0;
    const char *start=target;
    const char *end=target+target_len;

    while ( (start=findchar(start, end-start, c)) != NULL ) {
        count++;
        if (count >= maxcount)
            break;
        start += 1;
    }
    return count;
}


/* Algorithms for different cases of string replacement */

/* len(self)>=1, from="", len(to)>=1, maxcount>=1 */
Py_LOCAL(PyByteArrayObject *)
replace_interleave(PyByteArrayObject *self,
                   const char *to_s, Py_ssize_t to_len,
                   Py_ssize_t maxcount)
{
    char *self_s, *result_s;
    Py_ssize_t self_len, result_len;
1564
    Py_ssize_t count, i;
1565 1566 1567 1568
    PyByteArrayObject *result;

    self_len = PyByteArray_GET_SIZE(self);

1569 1570 1571
    /* 1 at the end plus 1 after every character;
       count = min(maxcount, self_len + 1) */
    if (maxcount <= self_len)
1572
        count = maxcount;
1573 1574 1575
    else
        /* Can't overflow: self_len + 1 <= maxcount <= PY_SSIZE_T_MAX. */
        count = self_len + 1;
1576 1577 1578

    /* Check for overflow */
    /*   result_len = count * to_len + self_len; */
1579 1580
    assert(count > 0);
    if (to_len > (PY_SSIZE_T_MAX - self_len) / count) {
1581 1582 1583 1584
        PyErr_SetString(PyExc_OverflowError,
                        "replace string is too long");
        return NULL;
    }
1585
    result_len = count * to_len + self_len;
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671

    if (! (result = (PyByteArrayObject *)
                     PyByteArray_FromStringAndSize(NULL, result_len)) )
        return NULL;

    self_s = PyByteArray_AS_STRING(self);
    result_s = PyByteArray_AS_STRING(result);

    /* TODO: special case single character, which doesn't need memcpy */

    /* Lay the first one down (guaranteed this will occur) */
    Py_MEMCPY(result_s, to_s, to_len);
    result_s += to_len;
    count -= 1;

    for (i=0; i<count; i++) {
        *result_s++ = *self_s++;
        Py_MEMCPY(result_s, to_s, to_len);
        result_s += to_len;
    }

    /* Copy the rest of the original string */
    Py_MEMCPY(result_s, self_s, self_len-i);

    return result;
}

/* Special case for deleting a single character */
/* len(self)>=1, len(from)==1, to="", maxcount>=1 */
Py_LOCAL(PyByteArrayObject *)
replace_delete_single_character(PyByteArrayObject *self,
                                char from_c, Py_ssize_t maxcount)
{
    char *self_s, *result_s;
    char *start, *next, *end;
    Py_ssize_t self_len, result_len;
    Py_ssize_t count;
    PyByteArrayObject *result;

    self_len = PyByteArray_GET_SIZE(self);
    self_s = PyByteArray_AS_STRING(self);

    count = countchar(self_s, self_len, from_c, maxcount);
    if (count == 0) {
        return return_self(self);
    }

    result_len = self_len - count;  /* from_len == 1 */
    assert(result_len>=0);

    if ( (result = (PyByteArrayObject *)
                    PyByteArray_FromStringAndSize(NULL, result_len)) == NULL)
        return NULL;
    result_s = PyByteArray_AS_STRING(result);

    start = self_s;
    end = self_s + self_len;
    while (count-- > 0) {
        next = findchar(start, end-start, from_c);
        if (next == NULL)
            break;
        Py_MEMCPY(result_s, start, next-start);
        result_s += (next-start);
        start = next+1;
    }
    Py_MEMCPY(result_s, start, end-start);

    return result;
}

/* len(self)>=1, len(from)>=2, to="", maxcount>=1 */

Py_LOCAL(PyByteArrayObject *)
replace_delete_substring(PyByteArrayObject *self,
                         const char *from_s, Py_ssize_t from_len,
                         Py_ssize_t maxcount)
{
    char *self_s, *result_s;
    char *start, *next, *end;
    Py_ssize_t self_len, result_len;
    Py_ssize_t count, offset;
    PyByteArrayObject *result;

    self_len = PyByteArray_GET_SIZE(self);
    self_s = PyByteArray_AS_STRING(self);

1672 1673 1674
    count = stringlib_count(self_s, self_len,
                            from_s, from_len,
                            maxcount);
1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692

    if (count == 0) {
        /* no matches */
        return return_self(self);
    }

    result_len = self_len - (count * from_len);
    assert (result_len>=0);

    if ( (result = (PyByteArrayObject *)
        PyByteArray_FromStringAndSize(NULL, result_len)) == NULL )
            return NULL;

    result_s = PyByteArray_AS_STRING(result);

    start = self_s;
    end = self_s + self_len;
    while (count-- > 0) {
1693 1694 1695
        offset = stringlib_find(start, end-start,
                                from_s, from_len,
                                0);
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714
        if (offset == -1)
            break;
        next = start + offset;

        Py_MEMCPY(result_s, start, next-start);

        result_s += (next-start);
        start = next+from_len;
    }
    Py_MEMCPY(result_s, start, end-start);
    return result;
}

/* len(self)>=1, len(from)==len(to)==1, maxcount>=1 */
Py_LOCAL(PyByteArrayObject *)
replace_single_character_in_place(PyByteArrayObject *self,
                                  char from_c, char to_c,
                                  Py_ssize_t maxcount)
{
1715 1716 1717
    char *self_s, *result_s, *start, *end, *next;
    Py_ssize_t self_len;
    PyByteArrayObject *result;
1718

1719 1720 1721
    /* The result string will be the same size */
    self_s = PyByteArray_AS_STRING(self);
    self_len = PyByteArray_GET_SIZE(self);
1722

1723
    next = findchar(self_s, self_len, from_c);
1724

1725 1726 1727 1728
    if (next == NULL) {
        /* No matches; return the original bytes */
        return return_self(self);
    }
1729

1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741
    /* Need to make a new bytes */
    result = (PyByteArrayObject *) PyByteArray_FromStringAndSize(NULL, self_len);
    if (result == NULL)
        return NULL;
    result_s = PyByteArray_AS_STRING(result);
    Py_MEMCPY(result_s, self_s, self_len);

    /* change everything in-place, starting with this one */
    start =  result_s + (next-self_s);
    *start = to_c;
    start++;
    end = result_s + self_len;
1742

1743 1744 1745 1746 1747 1748 1749 1750 1751
    while (--maxcount > 0) {
        next = findchar(start, end-start, from_c);
        if (next == NULL)
            break;
        *next = to_c;
        start = next+1;
    }

    return result;
1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770
}

/* len(self)>=1, len(from)==len(to)>=2, maxcount>=1 */
Py_LOCAL(PyByteArrayObject *)
replace_substring_in_place(PyByteArrayObject *self,
                           const char *from_s, Py_ssize_t from_len,
                           const char *to_s, Py_ssize_t to_len,
                           Py_ssize_t maxcount)
{
    char *result_s, *start, *end;
    char *self_s;
    Py_ssize_t self_len, offset;
    PyByteArrayObject *result;

    /* The result bytes will be the same size */

    self_s = PyByteArray_AS_STRING(self);
    self_len = PyByteArray_GET_SIZE(self);

1771 1772 1773
    offset = stringlib_find(self_s, self_len,
                            from_s, from_len,
                            0);
1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
    if (offset == -1) {
        /* No matches; return the original bytes */
        return return_self(self);
    }

    /* Need to make a new bytes */
    result = (PyByteArrayObject *) PyByteArray_FromStringAndSize(NULL, self_len);
    if (result == NULL)
        return NULL;
    result_s = PyByteArray_AS_STRING(result);
    Py_MEMCPY(result_s, self_s, self_len);

    /* change everything in-place, starting with this one */
    start =  result_s + offset;
    Py_MEMCPY(start, to_s, from_len);
    start += from_len;
    end = result_s + self_len;

    while ( --maxcount > 0) {
1793 1794 1795
        offset = stringlib_find(start, end-start,
                                from_s, from_len,
                                0);
1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
        if (offset==-1)
            break;
        Py_MEMCPY(start+offset, to_s, from_len);
        start += offset+from_len;
    }

    return result;
}

/* len(self)>=1, len(from)==1, len(to)>=2, maxcount>=1 */
Py_LOCAL(PyByteArrayObject *)
replace_single_character(PyByteArrayObject *self,
                         char from_c,
                         const char *to_s, Py_ssize_t to_len,
                         Py_ssize_t maxcount)
{
    char *self_s, *result_s;
    char *start, *next, *end;
    Py_ssize_t self_len, result_len;
1815
    Py_ssize_t count;
1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828
    PyByteArrayObject *result;

    self_s = PyByteArray_AS_STRING(self);
    self_len = PyByteArray_GET_SIZE(self);

    count = countchar(self_s, self_len, from_c, maxcount);
    if (count == 0) {
        /* no matches, return unchanged */
        return return_self(self);
    }

    /* use the difference between current and new, hence the "-1" */
    /*   result_len = self_len + count * (to_len-1)  */
1829 1830
    assert(count > 0);
    if (to_len - 1 > (PY_SSIZE_T_MAX - self_len) / count) {
1831 1832 1833
        PyErr_SetString(PyExc_OverflowError, "replace bytes is too long");
        return NULL;
    }
1834
    result_len = self_len + count * (to_len - 1);
1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877

    if ( (result = (PyByteArrayObject *)
          PyByteArray_FromStringAndSize(NULL, result_len)) == NULL)
            return NULL;
    result_s = PyByteArray_AS_STRING(result);

    start = self_s;
    end = self_s + self_len;
    while (count-- > 0) {
        next = findchar(start, end-start, from_c);
        if (next == NULL)
            break;

        if (next == start) {
            /* replace with the 'to' */
            Py_MEMCPY(result_s, to_s, to_len);
            result_s += to_len;
            start += 1;
        } else {
            /* copy the unchanged old then the 'to' */
            Py_MEMCPY(result_s, start, next-start);
            result_s += (next-start);
            Py_MEMCPY(result_s, to_s, to_len);
            result_s += to_len;
            start = next+1;
        }
    }
    /* Copy the remainder of the remaining bytes */
    Py_MEMCPY(result_s, start, end-start);

    return result;
}

/* len(self)>=1, len(from)>=2, len(to)>=2, maxcount>=1 */
Py_LOCAL(PyByteArrayObject *)
replace_substring(PyByteArrayObject *self,
                  const char *from_s, Py_ssize_t from_len,
                  const char *to_s, Py_ssize_t to_len,
                  Py_ssize_t maxcount)
{
    char *self_s, *result_s;
    char *start, *next, *end;
    Py_ssize_t self_len, result_len;
1878
    Py_ssize_t count, offset;
1879 1880 1881 1882 1883
    PyByteArrayObject *result;

    self_s = PyByteArray_AS_STRING(self);
    self_len = PyByteArray_GET_SIZE(self);

1884 1885 1886 1887
    count = stringlib_count(self_s, self_len,
                            from_s, from_len,
                            maxcount);

1888 1889 1890 1891 1892 1893 1894
    if (count == 0) {
        /* no matches, return unchanged */
        return return_self(self);
    }

    /* Check for overflow */
    /*    result_len = self_len + count * (to_len-from_len) */
1895 1896
    assert(count > 0);
    if (to_len - from_len > (PY_SSIZE_T_MAX - self_len) / count) {
1897 1898 1899
        PyErr_SetString(PyExc_OverflowError, "replace bytes is too long");
        return NULL;
    }
1900
    result_len = self_len + count * (to_len - from_len);
1901 1902 1903 1904 1905 1906 1907 1908 1909

    if ( (result = (PyByteArrayObject *)
          PyByteArray_FromStringAndSize(NULL, result_len)) == NULL)
        return NULL;
    result_s = PyByteArray_AS_STRING(result);

    start = self_s;
    end = self_s + self_len;
    while (count-- > 0) {
1910 1911 1912
        offset = stringlib_find(start, end-start,
                                from_s, from_len,
                                0);
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972
        if (offset == -1)
            break;
        next = start+offset;
        if (next == start) {
            /* replace with the 'to' */
            Py_MEMCPY(result_s, to_s, to_len);
            result_s += to_len;
            start += from_len;
        } else {
            /* copy the unchanged old then the 'to' */
            Py_MEMCPY(result_s, start, next-start);
            result_s += (next-start);
            Py_MEMCPY(result_s, to_s, to_len);
            result_s += to_len;
            start = next+from_len;
        }
    }
    /* Copy the remainder of the remaining bytes */
    Py_MEMCPY(result_s, start, end-start);

    return result;
}


Py_LOCAL(PyByteArrayObject *)
replace(PyByteArrayObject *self,
        const char *from_s, Py_ssize_t from_len,
        const char *to_s, Py_ssize_t to_len,
        Py_ssize_t maxcount)
{
    if (maxcount < 0) {
        maxcount = PY_SSIZE_T_MAX;
    } else if (maxcount == 0 || PyByteArray_GET_SIZE(self) == 0) {
        /* nothing to do; return the original bytes */
        return return_self(self);
    }

    if (maxcount == 0 ||
        (from_len == 0 && to_len == 0)) {
        /* nothing to do; return the original bytes */
        return return_self(self);
    }

    /* Handle zero-length special cases */

    if (from_len == 0) {
        /* insert the 'to' bytes everywhere.   */
        /*    >>> "Python".replace("", ".")     */
        /*    '.P.y.t.h.o.n.'                   */
        return replace_interleave(self, to_s, to_len, maxcount);
    }

    /* Except for "".replace("", "A") == "A" there is no way beyond this */
    /* point for an empty self bytes to generate a non-empty bytes */
    /* Special case so the remaining code always gets a non-empty bytes */
    if (PyByteArray_GET_SIZE(self) == 0) {
        return return_self(self);
    }

    if (to_len == 0) {
1973
        /* delete all occurrences of 'from' bytes */
1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008
        if (from_len == 1) {
            return replace_delete_single_character(
                    self, from_s[0], maxcount);
        } else {
            return replace_delete_substring(self, from_s, from_len, maxcount);
        }
    }

    /* Handle special case where both bytes have the same length */

    if (from_len == to_len) {
        if (from_len == 1) {
            return replace_single_character_in_place(
                    self,
                    from_s[0],
                    to_s[0],
                    maxcount);
        } else {
            return replace_substring_in_place(
                self, from_s, from_len, to_s, to_len, maxcount);
        }
    }

    /* Otherwise use the more generic algorithms */
    if (from_len == 1) {
        return replace_single_character(self, from_s[0],
                                        to_s, to_len, maxcount);
    } else {
        /* len('from')>=2, len('to')>=1 */
        return replace_substring(self, from_s, from_len, to_s, to_len, maxcount);
    }
}


PyDoc_STRVAR(replace__doc__,
2009
"B.replace(old, new[, count]) -> bytearray\n\
2010 2011 2012 2013 2014 2015
\n\
Return a copy of B with all occurrences of subsection\n\
old replaced by new.  If the optional argument count is\n\
given, only the first count occurrences are replaced.");

static PyObject *
2016
bytearray_replace(PyByteArrayObject *self, PyObject *args)
2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
{
    Py_ssize_t count = -1;
    PyObject *from, *to, *res;
    Py_buffer vfrom, vto;

    if (!PyArg_ParseTuple(args, "OO|n:replace", &from, &to, &count))
        return NULL;

    if (_getbuffer(from, &vfrom) < 0)
        return NULL;
    if (_getbuffer(to, &vto) < 0) {
2028
        PyBuffer_Release(&vfrom);
2029 2030 2031 2032 2033 2034 2035
        return NULL;
    }

    res = (PyObject *)replace((PyByteArrayObject *) self,
                              vfrom.buf, vfrom.len,
                              vto.buf, vto.len, count);

2036 2037
    PyBuffer_Release(&vfrom);
    PyBuffer_Release(&vto);
2038 2039 2040 2041
    return res;
}

PyDoc_STRVAR(split__doc__,
2042
"B.split(sep=None, maxsplit=-1) -> list of bytearrays\n\
2043 2044 2045 2046 2047 2048 2049
\n\
Return a list of the sections in B, using sep as the delimiter.\n\
If sep is not given, B is split on ASCII whitespace characters\n\
(space, tab, return, newline, formfeed, vertical tab).\n\
If maxsplit is given, at most maxsplit splits are done.");

static PyObject *
2050
bytearray_split(PyByteArrayObject *self, PyObject *args, PyObject *kwds)
2051
{
2052
    static char *kwlist[] = {"sep", "maxsplit", 0};
2053 2054
    Py_ssize_t len = PyByteArray_GET_SIZE(self), n;
    Py_ssize_t maxsplit = -1;
2055
    const char *s = PyByteArray_AS_STRING(self), *sub;
2056
    PyObject *list, *subobj = Py_None;
2057 2058
    Py_buffer vsub;

2059 2060
    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|On:split",
                                     kwlist, &subobj, &maxsplit))
2061 2062 2063 2064 2065
        return NULL;
    if (maxsplit < 0)
        maxsplit = PY_SSIZE_T_MAX;

    if (subobj == Py_None)
2066
        return stringlib_split_whitespace((PyObject*) self, s, len, maxsplit);
2067 2068 2069 2070 2071 2072

    if (_getbuffer(subobj, &vsub) < 0)
        return NULL;
    sub = vsub.buf;
    n = vsub.len;

2073 2074 2075
    list = stringlib_split(
        (PyObject*) self, s, len, sub, n, maxsplit
        );
2076
    PyBuffer_Release(&vsub);
2077 2078 2079 2080 2081 2082
    return list;
}

PyDoc_STRVAR(partition__doc__,
"B.partition(sep) -> (head, sep, tail)\n\
\n\
2083
Search for the separator sep in B, and return the part before it,\n\
2084 2085 2086 2087
the separator itself, and the part after it.  If the separator is not\n\
found, returns B and two empty bytearray objects.");

static PyObject *
2088
bytearray_partition(PyByteArrayObject *self, PyObject *sep_obj)
2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103
{
    PyObject *bytesep, *result;

    bytesep = PyByteArray_FromObject(sep_obj);
    if (! bytesep)
        return NULL;

    result = stringlib_partition(
            (PyObject*) self,
            PyByteArray_AS_STRING(self), PyByteArray_GET_SIZE(self),
            bytesep,
            PyByteArray_AS_STRING(bytesep), PyByteArray_GET_SIZE(bytesep)
            );

    Py_DECREF(bytesep);
2104
    return result;
2105 2106 2107
}

PyDoc_STRVAR(rpartition__doc__,
2108
"B.rpartition(sep) -> (head, sep, tail)\n\
2109
\n\
2110 2111
Search for the separator sep in B, starting at the end of B,\n\
and return the part before it, the separator itself, and the\n\
2112 2113 2114 2115
part after it.  If the separator is not found, returns two empty\n\
bytearray objects and B.");

static PyObject *
2116
bytearray_rpartition(PyByteArrayObject *self, PyObject *sep_obj)
2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131
{
    PyObject *bytesep, *result;

    bytesep = PyByteArray_FromObject(sep_obj);
    if (! bytesep)
        return NULL;

    result = stringlib_rpartition(
            (PyObject*) self,
            PyByteArray_AS_STRING(self), PyByteArray_GET_SIZE(self),
            bytesep,
            PyByteArray_AS_STRING(bytesep), PyByteArray_GET_SIZE(bytesep)
            );

    Py_DECREF(bytesep);
2132
    return result;
2133 2134 2135
}

PyDoc_STRVAR(rsplit__doc__,
2136
"B.rsplit(sep=None, maxsplit=-1) -> list of bytearrays\n\
2137 2138 2139 2140 2141 2142 2143 2144
\n\
Return a list of the sections in B, using sep as the delimiter,\n\
starting at the end of B and working to the front.\n\
If sep is not given, B is split on ASCII whitespace characters\n\
(space, tab, return, newline, formfeed, vertical tab).\n\
If maxsplit is given, at most maxsplit splits are done.");

static PyObject *
2145
bytearray_rsplit(PyByteArrayObject *self, PyObject *args, PyObject *kwds)
2146
{
2147
    static char *kwlist[] = {"sep", "maxsplit", 0};
2148 2149
    Py_ssize_t len = PyByteArray_GET_SIZE(self), n;
    Py_ssize_t maxsplit = -1;
2150
    const char *s = PyByteArray_AS_STRING(self), *sub;
2151
    PyObject *list, *subobj = Py_None;
2152 2153
    Py_buffer vsub;

2154 2155
    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|On:rsplit",
                                     kwlist, &subobj, &maxsplit))
2156 2157 2158 2159 2160
        return NULL;
    if (maxsplit < 0)
        maxsplit = PY_SSIZE_T_MAX;

    if (subobj == Py_None)
2161
        return stringlib_rsplit_whitespace((PyObject*) self, s, len, maxsplit);
2162 2163 2164 2165 2166 2167

    if (_getbuffer(subobj, &vsub) < 0)
        return NULL;
    sub = vsub.buf;
    n = vsub.len;

2168 2169 2170
    list = stringlib_rsplit(
        (PyObject*) self, s, len, sub, n, maxsplit
        );
2171
    PyBuffer_Release(&vsub);
2172 2173 2174 2175 2176 2177 2178 2179
    return list;
}

PyDoc_STRVAR(reverse__doc__,
"B.reverse() -> None\n\
\n\
Reverse the order of the values in B in place.");
static PyObject *
2180
bytearray_reverse(PyByteArrayObject *self, PyObject *unused)
2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201
{
    char swap, *head, *tail;
    Py_ssize_t i, j, n = Py_SIZE(self);

    j = n / 2;
    head = self->ob_bytes;
    tail = head + n - 1;
    for (i = 0; i < j; i++) {
        swap = *head;
        *head++ = *tail;
        *tail-- = swap;
    }

    Py_RETURN_NONE;
}

PyDoc_STRVAR(insert__doc__,
"B.insert(index, int) -> None\n\
\n\
Insert a single item into the bytearray before the given index.");
static PyObject *
2202
bytearray_insert(PyByteArrayObject *self, PyObject *args)
2203
{
2204 2205
    PyObject *value;
    int ival;
2206 2207
    Py_ssize_t where, n = Py_SIZE(self);

2208
    if (!PyArg_ParseTuple(args, "nO:insert", &where, &value))
2209 2210 2211 2212
        return NULL;

    if (n == PY_SSIZE_T_MAX) {
        PyErr_SetString(PyExc_OverflowError,
2213
                        "cannot add more objects to bytearray");
2214 2215
        return NULL;
    }
2216
    if (!_getbytevalue(value, &ival))
2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228
        return NULL;
    if (PyByteArray_Resize((PyObject *)self, n + 1) < 0)
        return NULL;

    if (where < 0) {
        where += n;
        if (where < 0)
            where = 0;
    }
    if (where > n)
        where = n;
    memmove(self->ob_bytes + where + 1, self->ob_bytes + where, n - where);
2229
    self->ob_bytes[where] = ival;
2230 2231 2232 2233 2234 2235 2236 2237 2238

    Py_RETURN_NONE;
}

PyDoc_STRVAR(append__doc__,
"B.append(int) -> None\n\
\n\
Append a single item to the end of B.");
static PyObject *
2239
bytearray_append(PyByteArrayObject *self, PyObject *arg)
2240 2241 2242 2243 2244 2245 2246 2247
{
    int value;
    Py_ssize_t n = Py_SIZE(self);

    if (! _getbytevalue(arg, &value))
        return NULL;
    if (n == PY_SSIZE_T_MAX) {
        PyErr_SetString(PyExc_OverflowError,
2248
                        "cannot add more objects to bytearray");
2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259
        return NULL;
    }
    if (PyByteArray_Resize((PyObject *)self, n + 1) < 0)
        return NULL;

    self->ob_bytes[n] = value;

    Py_RETURN_NONE;
}

PyDoc_STRVAR(extend__doc__,
2260
"B.extend(iterable_of_ints) -> None\n\
2261 2262 2263 2264
\n\
Append all the elements from the iterator or sequence to the\n\
end of B.");
static PyObject *
2265
bytearray_extend(PyByteArrayObject *self, PyObject *arg)
2266
{
2267
    PyObject *it, *item, *bytearray_obj;
2268 2269 2270 2271
    Py_ssize_t buf_size = 0, len = 0;
    int value;
    char *buf;

2272
    /* bytearray_setslice code only accepts something supporting PEP 3118. */
2273
    if (PyObject_CheckBuffer(arg)) {
2274
        if (bytearray_setslice(self, Py_SIZE(self), Py_SIZE(self), arg) == -1)
2275 2276 2277 2278 2279 2280 2281 2282 2283
            return NULL;

        Py_RETURN_NONE;
    }

    it = PyObject_GetIter(arg);
    if (it == NULL)
        return NULL;

2284
    /* Try to determine the length of the argument. 32 is arbitrary. */
2285
    buf_size = _PyObject_LengthHint(arg, 32);
Benjamin Peterson's avatar
Benjamin Peterson committed
2286 2287 2288 2289
    if (buf_size == -1) {
        Py_DECREF(it);
        return NULL;
    }
2290

2291
    bytearray_obj = PyByteArray_FromStringAndSize(NULL, buf_size);
2292 2293
    if (bytearray_obj == NULL) {
        Py_DECREF(it);
2294
        return NULL;
2295
    }
2296
    buf = PyByteArray_AS_STRING(bytearray_obj);
2297 2298 2299 2300 2301

    while ((item = PyIter_Next(it)) != NULL) {
        if (! _getbytevalue(item, &value)) {
            Py_DECREF(item);
            Py_DECREF(it);
2302
            Py_DECREF(bytearray_obj);
2303 2304 2305 2306 2307 2308 2309
            return NULL;
        }
        buf[len++] = value;
        Py_DECREF(item);

        if (len >= buf_size) {
            buf_size = len + (len >> 1) + 1;
2310
            if (PyByteArray_Resize((PyObject *)bytearray_obj, buf_size) < 0) {
2311
                Py_DECREF(it);
2312
                Py_DECREF(bytearray_obj);
2313 2314 2315 2316
                return NULL;
            }
            /* Recompute the `buf' pointer, since the resizing operation may
               have invalidated it. */
2317
            buf = PyByteArray_AS_STRING(bytearray_obj);
2318 2319 2320 2321 2322
        }
    }
    Py_DECREF(it);

    /* Resize down to exact size. */
2323 2324
    if (PyByteArray_Resize((PyObject *)bytearray_obj, len) < 0) {
        Py_DECREF(bytearray_obj);
2325 2326 2327
        return NULL;
    }

2328 2329
    if (bytearray_setslice(self, Py_SIZE(self), Py_SIZE(self), bytearray_obj) == -1) {
        Py_DECREF(bytearray_obj);
2330
        return NULL;
2331
    }
2332
    Py_DECREF(bytearray_obj);
2333 2334 2335 2336 2337 2338 2339 2340

    Py_RETURN_NONE;
}

PyDoc_STRVAR(pop__doc__,
"B.pop([index]) -> int\n\
\n\
Remove and return a single item from B. If no index\n\
Benjamin Peterson's avatar
Benjamin Peterson committed
2341
argument is given, will pop the last value.");
2342
static PyObject *
2343
bytearray_pop(PyByteArrayObject *self, PyObject *args)
2344 2345 2346 2347 2348 2349 2350 2351
{
    int value;
    Py_ssize_t where = -1, n = Py_SIZE(self);

    if (!PyArg_ParseTuple(args, "|n:pop", &where))
        return NULL;

    if (n == 0) {
2352 2353
        PyErr_SetString(PyExc_IndexError,
                        "pop from empty bytearray");
2354 2355 2356 2357 2358 2359 2360 2361
        return NULL;
    }
    if (where < 0)
        where += Py_SIZE(self);
    if (where < 0 || where >= Py_SIZE(self)) {
        PyErr_SetString(PyExc_IndexError, "pop index out of range");
        return NULL;
    }
2362 2363
    if (!_canresize(self))
        return NULL;
2364 2365 2366 2367 2368 2369

    value = self->ob_bytes[where];
    memmove(self->ob_bytes + where, self->ob_bytes + where + 1, n - where);
    if (PyByteArray_Resize((PyObject *)self, n - 1) < 0)
        return NULL;

2370
    return PyLong_FromLong((unsigned char)value);
2371 2372 2373 2374 2375
}

PyDoc_STRVAR(remove__doc__,
"B.remove(int) -> None\n\
\n\
2376
Remove the first occurrence of a value in B.");
2377
static PyObject *
2378
bytearray_remove(PyByteArrayObject *self, PyObject *arg)
2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390
{
    int value;
    Py_ssize_t where, n = Py_SIZE(self);

    if (! _getbytevalue(arg, &value))
        return NULL;

    for (where = 0; where < n; where++) {
        if (self->ob_bytes[where] == value)
            break;
    }
    if (where == n) {
2391
        PyErr_SetString(PyExc_ValueError, "value not found in bytearray");
2392 2393
        return NULL;
    }
2394 2395
    if (!_canresize(self))
        return NULL;
2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428

    memmove(self->ob_bytes + where, self->ob_bytes + where + 1, n - where);
    if (PyByteArray_Resize((PyObject *)self, n - 1) < 0)
        return NULL;

    Py_RETURN_NONE;
}

/* XXX These two helpers could be optimized if argsize == 1 */

static Py_ssize_t
lstrip_helper(unsigned char *myptr, Py_ssize_t mysize,
              void *argptr, Py_ssize_t argsize)
{
    Py_ssize_t i = 0;
    while (i < mysize && memchr(argptr, myptr[i], argsize))
        i++;
    return i;
}

static Py_ssize_t
rstrip_helper(unsigned char *myptr, Py_ssize_t mysize,
              void *argptr, Py_ssize_t argsize)
{
    Py_ssize_t i = mysize - 1;
    while (i >= 0 && memchr(argptr, myptr[i], argsize))
        i--;
    return i + 1;
}

PyDoc_STRVAR(strip__doc__,
"B.strip([bytes]) -> bytearray\n\
\n\
2429 2430
Strip leading and trailing bytes contained in the argument\n\
and return the result as a new bytearray.\n\
2431 2432
If the argument is omitted, strip ASCII whitespace.");
static PyObject *
2433
bytearray_strip(PyByteArrayObject *self, PyObject *args)
2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458
{
    Py_ssize_t left, right, mysize, argsize;
    void *myptr, *argptr;
    PyObject *arg = Py_None;
    Py_buffer varg;
    if (!PyArg_ParseTuple(args, "|O:strip", &arg))
        return NULL;
    if (arg == Py_None) {
        argptr = "\t\n\r\f\v ";
        argsize = 6;
    }
    else {
        if (_getbuffer(arg, &varg) < 0)
            return NULL;
        argptr = varg.buf;
        argsize = varg.len;
    }
    myptr = self->ob_bytes;
    mysize = Py_SIZE(self);
    left = lstrip_helper(myptr, mysize, argptr, argsize);
    if (left == mysize)
        right = left;
    else
        right = rstrip_helper(myptr, mysize, argptr, argsize);
    if (arg != Py_None)
2459
        PyBuffer_Release(&varg);
2460 2461 2462 2463 2464 2465
    return PyByteArray_FromStringAndSize(self->ob_bytes + left, right - left);
}

PyDoc_STRVAR(lstrip__doc__,
"B.lstrip([bytes]) -> bytearray\n\
\n\
2466 2467
Strip leading bytes contained in the argument\n\
and return the result as a new bytearray.\n\
2468 2469
If the argument is omitted, strip leading ASCII whitespace.");
static PyObject *
2470
bytearray_lstrip(PyByteArrayObject *self, PyObject *args)
2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492
{
    Py_ssize_t left, right, mysize, argsize;
    void *myptr, *argptr;
    PyObject *arg = Py_None;
    Py_buffer varg;
    if (!PyArg_ParseTuple(args, "|O:lstrip", &arg))
        return NULL;
    if (arg == Py_None) {
        argptr = "\t\n\r\f\v ";
        argsize = 6;
    }
    else {
        if (_getbuffer(arg, &varg) < 0)
            return NULL;
        argptr = varg.buf;
        argsize = varg.len;
    }
    myptr = self->ob_bytes;
    mysize = Py_SIZE(self);
    left = lstrip_helper(myptr, mysize, argptr, argsize);
    right = mysize;
    if (arg != Py_None)
2493
        PyBuffer_Release(&varg);
2494 2495 2496 2497 2498 2499
    return PyByteArray_FromStringAndSize(self->ob_bytes + left, right - left);
}

PyDoc_STRVAR(rstrip__doc__,
"B.rstrip([bytes]) -> bytearray\n\
\n\
2500 2501
Strip trailing bytes contained in the argument\n\
and return the result as a new bytearray.\n\
2502 2503
If the argument is omitted, strip trailing ASCII whitespace.");
static PyObject *
2504
bytearray_rstrip(PyByteArrayObject *self, PyObject *args)
2505
{
2506
    Py_ssize_t right, mysize, argsize;
2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525
    void *myptr, *argptr;
    PyObject *arg = Py_None;
    Py_buffer varg;
    if (!PyArg_ParseTuple(args, "|O:rstrip", &arg))
        return NULL;
    if (arg == Py_None) {
        argptr = "\t\n\r\f\v ";
        argsize = 6;
    }
    else {
        if (_getbuffer(arg, &varg) < 0)
            return NULL;
        argptr = varg.buf;
        argsize = varg.len;
    }
    myptr = self->ob_bytes;
    mysize = Py_SIZE(self);
    right = rstrip_helper(myptr, mysize, argptr, argsize);
    if (arg != Py_None)
2526
        PyBuffer_Release(&varg);
2527
    return PyByteArray_FromStringAndSize(self->ob_bytes, right);
2528 2529 2530
}

PyDoc_STRVAR(decode_doc,
2531
"B.decode(encoding='utf-8', errors='strict') -> str\n\
2532
\n\
2533 2534
Decode B using the codec registered for encoding. Default encoding\n\
is 'utf-8'. errors may be given to set a different error\n\
2535 2536 2537 2538 2539 2540
handling scheme.  Default is 'strict' meaning that encoding errors raise\n\
a UnicodeDecodeError.  Other possible values are 'ignore' and 'replace'\n\
as well as any other name registered with codecs.register_error that is\n\
able to handle UnicodeDecodeErrors.");

static PyObject *
2541
bytearray_decode(PyObject *self, PyObject *args, PyObject *kwargs)
2542 2543 2544
{
    const char *encoding = NULL;
    const char *errors = NULL;
2545
    static char *kwlist[] = {"encoding", "errors", 0};
2546

2547
    if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|ss:decode", kwlist, &encoding, &errors))
2548 2549 2550
        return NULL;
    if (encoding == NULL)
        encoding = PyUnicode_GetDefaultEncoding();
2551
    return PyUnicode_FromEncodedObject(self, encoding, errors);
2552 2553 2554 2555 2556
}

PyDoc_STRVAR(alloc_doc,
"B.__alloc__() -> int\n\
\n\
2557
Return the number of bytes actually allocated.");
2558 2559

static PyObject *
2560
bytearray_alloc(PyByteArrayObject *self)
2561 2562 2563 2564 2565
{
    return PyLong_FromSsize_t(self->ob_alloc);
}

PyDoc_STRVAR(join_doc,
2566
"B.join(iterable_of_bytes) -> bytearray\n\
2567
\n\
2568 2569
Concatenate any number of bytes/bytearray objects, with B\n\
in between each pair, and return the result as a new bytearray.");
2570 2571

static PyObject *
2572
bytearray_join(PyByteArrayObject *self, PyObject *it)
2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640
{
    PyObject *seq;
    Py_ssize_t mysize = Py_SIZE(self);
    Py_ssize_t i;
    Py_ssize_t n;
    PyObject **items;
    Py_ssize_t totalsize = 0;
    PyObject *result;
    char *dest;

    seq = PySequence_Fast(it, "can only join an iterable");
    if (seq == NULL)
        return NULL;
    n = PySequence_Fast_GET_SIZE(seq);
    items = PySequence_Fast_ITEMS(seq);

    /* Compute the total size, and check that they are all bytes */
    /* XXX Shouldn't we use _getbuffer() on these items instead? */
    for (i = 0; i < n; i++) {
        PyObject *obj = items[i];
        if (!PyByteArray_Check(obj) && !PyBytes_Check(obj)) {
            PyErr_Format(PyExc_TypeError,
                         "can only join an iterable of bytes "
                         "(item %ld has type '%.100s')",
                         /* XXX %ld isn't right on Win64 */
                         (long)i, Py_TYPE(obj)->tp_name);
            goto error;
        }
        if (i > 0)
            totalsize += mysize;
        totalsize += Py_SIZE(obj);
        if (totalsize < 0) {
            PyErr_NoMemory();
            goto error;
        }
    }

    /* Allocate the result, and copy the bytes */
    result = PyByteArray_FromStringAndSize(NULL, totalsize);
    if (result == NULL)
        goto error;
    dest = PyByteArray_AS_STRING(result);
    for (i = 0; i < n; i++) {
        PyObject *obj = items[i];
        Py_ssize_t size = Py_SIZE(obj);
        char *buf;
        if (PyByteArray_Check(obj))
           buf = PyByteArray_AS_STRING(obj);
        else
           buf = PyBytes_AS_STRING(obj);
        if (i) {
            memcpy(dest, self->ob_bytes, mysize);
            dest += mysize;
        }
        memcpy(dest, buf, size);
        dest += size;
    }

    /* Done */
    Py_DECREF(seq);
    return result;

    /* Error handling */
  error:
    Py_DECREF(seq);
    return NULL;
}

2641 2642 2643 2644 2645 2646 2647 2648
PyDoc_STRVAR(splitlines__doc__,
"B.splitlines([keepends]) -> list of lines\n\
\n\
Return a list of the lines in B, breaking at line boundaries.\n\
Line breaks are not included in the resulting list unless keepends\n\
is given and true.");

static PyObject*
2649
bytearray_splitlines(PyObject *self, PyObject *args, PyObject *kwds)
2650
{
2651
    static char *kwlist[] = {"keepends", 0};
2652 2653
    int keepends = 0;

2654 2655
    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|i:splitlines",
                                     kwlist, &keepends))
2656 2657 2658 2659 2660 2661 2662 2663
        return NULL;

    return stringlib_splitlines(
        (PyObject*) self, PyByteArray_AS_STRING(self),
        PyByteArray_GET_SIZE(self), keepends
        );
}

2664
PyDoc_STRVAR(fromhex_doc,
2665
"bytearray.fromhex(string) -> bytearray (static method)\n\
2666 2667 2668 2669 2670 2671
\n\
Create a bytearray object from a string of hexadecimal numbers.\n\
Spaces between two numbers are accepted.\n\
Example: bytearray.fromhex('B9 01EF') -> bytearray(b'\\xb9\\x01\\xef').");

static int
2672
hex_digit_to_int(Py_UCS4 c)
2673 2674 2675
{
    if (c >= 128)
        return -1;
2676
    if (Py_ISDIGIT(c))
2677 2678
        return c - '0';
    else {
2679 2680
        if (Py_ISUPPER(c))
            c = Py_TOLOWER(c);
2681 2682 2683 2684 2685 2686 2687
        if (c >= 'a' && c <= 'f')
            return c - 'a' + 10;
    }
    return -1;
}

static PyObject *
2688
bytearray_fromhex(PyObject *cls, PyObject *args)
2689 2690 2691 2692 2693
{
    PyObject *newbytes, *hexobj;
    char *buf;
    Py_ssize_t hexlen, byteslen, i, j;
    int top, bot;
Martin v. Löwis's avatar
Martin v. Löwis committed
2694 2695
    void *data;
    unsigned int kind;
2696 2697 2698 2699

    if (!PyArg_ParseTuple(args, "U:fromhex", &hexobj))
        return NULL;
    assert(PyUnicode_Check(hexobj));
Martin v. Löwis's avatar
Martin v. Löwis committed
2700 2701 2702 2703 2704 2705
    if (PyUnicode_READY(hexobj))
        return NULL;
    kind = PyUnicode_KIND(hexobj);
    data = PyUnicode_DATA(hexobj);
    hexlen = PyUnicode_GET_LENGTH(hexobj);

2706 2707 2708 2709 2710 2711 2712
    byteslen = hexlen/2; /* This overestimates if there are spaces */
    newbytes = PyByteArray_FromStringAndSize(NULL, byteslen);
    if (!newbytes)
        return NULL;
    buf = PyByteArray_AS_STRING(newbytes);
    for (i = j = 0; i < hexlen; i += 2) {
        /* skip over spaces in the input */
Martin v. Löwis's avatar
Martin v. Löwis committed
2713
        while (PyUnicode_READ(kind, data, i) == ' ')
2714 2715 2716
            i++;
        if (i >= hexlen)
            break;
Martin v. Löwis's avatar
Martin v. Löwis committed
2717 2718
        top = hex_digit_to_int(PyUnicode_READ(kind, data, i));
        bot = hex_digit_to_int(PyUnicode_READ(kind, data, i+1));
2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737
        if (top == -1 || bot == -1) {
            PyErr_Format(PyExc_ValueError,
                         "non-hexadecimal number found in "
                         "fromhex() arg at position %zd", i);
            goto error;
        }
        buf[j++] = (top << 4) + bot;
    }
    if (PyByteArray_Resize(newbytes, j) < 0)
        goto error;
    return newbytes;

  error:
    Py_DECREF(newbytes);
    return NULL;
}


static PyObject *
2738
_common_reduce(PyByteArrayObject *self, int proto)
2739
{
2740
    PyObject *dict;
2741
    _Py_IDENTIFIER(__dict__);
2742 2743

    dict = _PyObject_GetAttrId((PyObject *)self, &PyId___dict__);
2744 2745 2746 2747 2748 2749
    if (dict == NULL) {
        PyErr_Clear();
        dict = Py_None;
        Py_INCREF(dict);
    }

2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788
    if (proto < 3) {
        /* use str based reduction for backwards compatibility with Python 2.x */
        PyObject *latin1;
        if (self->ob_bytes)
            latin1 = PyUnicode_DecodeLatin1(self->ob_bytes, Py_SIZE(self), NULL);
        else
            latin1 = PyUnicode_FromString("");
        return Py_BuildValue("(O(Ns)N)", Py_TYPE(self), latin1, "latin-1", dict);
    }
    else {
        /* use more efficient byte based reduction */
        if (self->ob_bytes) {
            return Py_BuildValue("(O(y#)N)", Py_TYPE(self), self->ob_bytes, Py_SIZE(self), dict);
        }
        else {
            return Py_BuildValue("(O()N)", Py_TYPE(self), dict);
        }
    }
}

PyDoc_STRVAR(reduce_doc, "Return state information for pickling.");

static PyObject *
bytearray_reduce(PyByteArrayObject *self)
{
    return _common_reduce(self, 2);
}

PyDoc_STRVAR(reduce_ex_doc, "Return state information for pickling.");

static PyObject *
bytearray_reduce_ex(PyByteArrayObject *self, PyObject *args)
{
    int proto = 0;

    if (!PyArg_ParseTuple(args, "|i:__reduce_ex__", &proto))
        return NULL;

    return _common_reduce(self, proto);
2789 2790
}

2791 2792 2793 2794 2795
PyDoc_STRVAR(sizeof_doc,
"B.__sizeof__() -> int\n\
 \n\
Returns the size of B in memory, in bytes");
static PyObject *
2796
bytearray_sizeof(PyByteArrayObject *self)
2797
{
Benjamin Peterson's avatar
Benjamin Peterson committed
2798
    Py_ssize_t res;
2799

Benjamin Peterson's avatar
Benjamin Peterson committed
2800 2801
    res = sizeof(PyByteArrayObject) + self->ob_alloc * sizeof(char);
    return PyLong_FromSsize_t(res);
2802 2803
}

2804 2805
static PySequenceMethods bytearray_as_sequence = {
    (lenfunc)bytearray_length,              /* sq_length */
2806
    (binaryfunc)PyByteArray_Concat,         /* sq_concat */
2807 2808 2809 2810 2811 2812 2813 2814
    (ssizeargfunc)bytearray_repeat,         /* sq_repeat */
    (ssizeargfunc)bytearray_getitem,        /* sq_item */
    0,                                      /* sq_slice */
    (ssizeobjargproc)bytearray_setitem,     /* sq_ass_item */
    0,                                      /* sq_ass_slice */
    (objobjproc)bytearray_contains,         /* sq_contains */
    (binaryfunc)bytearray_iconcat,          /* sq_inplace_concat */
    (ssizeargfunc)bytearray_irepeat,        /* sq_inplace_repeat */
2815 2816
};

2817 2818 2819 2820
static PyMappingMethods bytearray_as_mapping = {
    (lenfunc)bytearray_length,
    (binaryfunc)bytearray_subscript,
    (objobjargproc)bytearray_ass_subscript,
2821 2822
};

2823 2824 2825
static PyBufferProcs bytearray_as_buffer = {
    (getbufferproc)bytearray_getbuffer,
    (releasebufferproc)bytearray_releasebuffer,
2826 2827 2828
};

static PyMethodDef
2829 2830 2831
bytearray_methods[] = {
    {"__alloc__", (PyCFunction)bytearray_alloc, METH_NOARGS, alloc_doc},
    {"__reduce__", (PyCFunction)bytearray_reduce, METH_NOARGS, reduce_doc},
2832
    {"__reduce_ex__", (PyCFunction)bytearray_reduce_ex, METH_VARARGS, reduce_ex_doc},
2833 2834
    {"__sizeof__", (PyCFunction)bytearray_sizeof, METH_NOARGS, sizeof_doc},
    {"append", (PyCFunction)bytearray_append, METH_O, append__doc__},
2835 2836 2837
    {"capitalize", (PyCFunction)stringlib_capitalize, METH_NOARGS,
     _Py_capitalize__doc__},
    {"center", (PyCFunction)stringlib_center, METH_VARARGS, center__doc__},
2838 2839
    {"clear", (PyCFunction)bytearray_clear, METH_NOARGS, clear__doc__},
    {"copy", (PyCFunction)bytearray_copy, METH_NOARGS, copy__doc__},
2840
    {"count", (PyCFunction)bytearray_count, METH_VARARGS, count__doc__},
2841
    {"decode", (PyCFunction)bytearray_decode, METH_VARARGS | METH_KEYWORDS, decode_doc},
2842
    {"endswith", (PyCFunction)bytearray_endswith, METH_VARARGS, endswith__doc__},
2843 2844
    {"expandtabs", (PyCFunction)stringlib_expandtabs, METH_VARARGS,
     expandtabs__doc__},
2845 2846 2847
    {"extend", (PyCFunction)bytearray_extend, METH_O, extend__doc__},
    {"find", (PyCFunction)bytearray_find, METH_VARARGS, find__doc__},
    {"fromhex", (PyCFunction)bytearray_fromhex, METH_VARARGS|METH_CLASS,
2848
     fromhex_doc},
2849 2850
    {"index", (PyCFunction)bytearray_index, METH_VARARGS, index__doc__},
    {"insert", (PyCFunction)bytearray_insert, METH_VARARGS, insert__doc__},
2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864
    {"isalnum", (PyCFunction)stringlib_isalnum, METH_NOARGS,
     _Py_isalnum__doc__},
    {"isalpha", (PyCFunction)stringlib_isalpha, METH_NOARGS,
     _Py_isalpha__doc__},
    {"isdigit", (PyCFunction)stringlib_isdigit, METH_NOARGS,
     _Py_isdigit__doc__},
    {"islower", (PyCFunction)stringlib_islower, METH_NOARGS,
     _Py_islower__doc__},
    {"isspace", (PyCFunction)stringlib_isspace, METH_NOARGS,
     _Py_isspace__doc__},
    {"istitle", (PyCFunction)stringlib_istitle, METH_NOARGS,
     _Py_istitle__doc__},
    {"isupper", (PyCFunction)stringlib_isupper, METH_NOARGS,
     _Py_isupper__doc__},
2865
    {"join", (PyCFunction)bytearray_join, METH_O, join_doc},
2866 2867
    {"ljust", (PyCFunction)stringlib_ljust, METH_VARARGS, ljust__doc__},
    {"lower", (PyCFunction)stringlib_lower, METH_NOARGS, _Py_lower__doc__},
2868 2869
    {"lstrip", (PyCFunction)bytearray_lstrip, METH_VARARGS, lstrip__doc__},
    {"maketrans", (PyCFunction)bytearray_maketrans, METH_VARARGS|METH_STATIC,
2870
     _Py_maketrans__doc__},
2871 2872 2873 2874 2875 2876 2877
    {"partition", (PyCFunction)bytearray_partition, METH_O, partition__doc__},
    {"pop", (PyCFunction)bytearray_pop, METH_VARARGS, pop__doc__},
    {"remove", (PyCFunction)bytearray_remove, METH_O, remove__doc__},
    {"replace", (PyCFunction)bytearray_replace, METH_VARARGS, replace__doc__},
    {"reverse", (PyCFunction)bytearray_reverse, METH_NOARGS, reverse__doc__},
    {"rfind", (PyCFunction)bytearray_rfind, METH_VARARGS, rfind__doc__},
    {"rindex", (PyCFunction)bytearray_rindex, METH_VARARGS, rindex__doc__},
2878
    {"rjust", (PyCFunction)stringlib_rjust, METH_VARARGS, rjust__doc__},
2879
    {"rpartition", (PyCFunction)bytearray_rpartition, METH_O, rpartition__doc__},
2880
    {"rsplit", (PyCFunction)bytearray_rsplit, METH_VARARGS | METH_KEYWORDS, rsplit__doc__},
2881
    {"rstrip", (PyCFunction)bytearray_rstrip, METH_VARARGS, rstrip__doc__},
2882
    {"split", (PyCFunction)bytearray_split, METH_VARARGS | METH_KEYWORDS, split__doc__},
2883 2884
    {"splitlines", (PyCFunction)bytearray_splitlines,
     METH_VARARGS | METH_KEYWORDS, splitlines__doc__},
2885
    {"startswith", (PyCFunction)bytearray_startswith, METH_VARARGS ,
2886
     startswith__doc__},
2887
    {"strip", (PyCFunction)bytearray_strip, METH_VARARGS, strip__doc__},
2888 2889 2890
    {"swapcase", (PyCFunction)stringlib_swapcase, METH_NOARGS,
     _Py_swapcase__doc__},
    {"title", (PyCFunction)stringlib_title, METH_NOARGS, _Py_title__doc__},
2891
    {"translate", (PyCFunction)bytearray_translate, METH_VARARGS,
2892 2893 2894 2895 2896 2897
     translate__doc__},
    {"upper", (PyCFunction)stringlib_upper, METH_NOARGS, _Py_upper__doc__},
    {"zfill", (PyCFunction)stringlib_zfill, METH_VARARGS, zfill__doc__},
    {NULL}
};

2898
PyDoc_STRVAR(bytearray_doc,
2899 2900
"bytearray(iterable_of_ints) -> bytearray\n\
bytearray(string, encoding[, errors]) -> bytearray\n\
2901 2902 2903
bytearray(bytes_or_buffer) -> mutable copy of bytes_or_buffer\n\
bytearray(int) -> bytes array of size given by the parameter initialized with null bytes\n\
bytearray() -> empty bytes array\n\
2904 2905 2906 2907
\n\
Construct an mutable bytearray object from:\n\
  - an iterable yielding integers in range(256)\n\
  - a text string encoded using the specified encoding\n\
2908
  - a bytes or a buffer object\n\
2909
  - any object implementing the buffer API.\n\
2910
  - an integer");
2911 2912


2913
static PyObject *bytearray_iter(PyObject *seq);
2914 2915 2916 2917 2918 2919

PyTypeObject PyByteArray_Type = {
    PyVarObject_HEAD_INIT(&PyType_Type, 0)
    "bytearray",
    sizeof(PyByteArrayObject),
    0,
2920
    (destructor)bytearray_dealloc,       /* tp_dealloc */
2921 2922 2923
    0,                                  /* tp_print */
    0,                                  /* tp_getattr */
    0,                                  /* tp_setattr */
2924
    0,                                  /* tp_reserved */
2925
    (reprfunc)bytearray_repr,           /* tp_repr */
2926
    0,                                  /* tp_as_number */
2927 2928
    &bytearray_as_sequence,             /* tp_as_sequence */
    &bytearray_as_mapping,              /* tp_as_mapping */
2929 2930
    0,                                  /* tp_hash */
    0,                                  /* tp_call */
2931
    bytearray_str,                      /* tp_str */
2932 2933
    PyObject_GenericGetAttr,            /* tp_getattro */
    0,                                  /* tp_setattro */
2934
    &bytearray_as_buffer,               /* tp_as_buffer */
2935
    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
2936
    bytearray_doc,                      /* tp_doc */
2937 2938
    0,                                  /* tp_traverse */
    0,                                  /* tp_clear */
2939
    (richcmpfunc)bytearray_richcompare, /* tp_richcompare */
2940
    0,                                  /* tp_weaklistoffset */
2941
    bytearray_iter,                     /* tp_iter */
2942
    0,                                  /* tp_iternext */
2943
    bytearray_methods,                  /* tp_methods */
2944 2945 2946 2947 2948 2949 2950
    0,                                  /* tp_members */
    0,                                  /* tp_getset */
    0,                                  /* tp_base */
    0,                                  /* tp_dict */
    0,                                  /* tp_descr_get */
    0,                                  /* tp_descr_set */
    0,                                  /* tp_dictoffset */
2951
    (initproc)bytearray_init,           /* tp_init */
2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965
    PyType_GenericAlloc,                /* tp_alloc */
    PyType_GenericNew,                  /* tp_new */
    PyObject_Del,                       /* tp_free */
};

/*********************** Bytes Iterator ****************************/

typedef struct {
    PyObject_HEAD
    Py_ssize_t it_index;
    PyByteArrayObject *it_seq; /* Set to NULL when iterator is exhausted */
} bytesiterobject;

static void
2966
bytearrayiter_dealloc(bytesiterobject *it)
2967 2968 2969 2970 2971 2972 2973
{
    _PyObject_GC_UNTRACK(it);
    Py_XDECREF(it->it_seq);
    PyObject_GC_Del(it);
}

static int
2974
bytearrayiter_traverse(bytesiterobject *it, visitproc visit, void *arg)
2975 2976 2977 2978 2979 2980
{
    Py_VISIT(it->it_seq);
    return 0;
}

static PyObject *
2981
bytearrayiter_next(bytesiterobject *it)
2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005
{
    PyByteArrayObject *seq;
    PyObject *item;

    assert(it != NULL);
    seq = it->it_seq;
    if (seq == NULL)
        return NULL;
    assert(PyByteArray_Check(seq));

    if (it->it_index < PyByteArray_GET_SIZE(seq)) {
        item = PyLong_FromLong(
            (unsigned char)seq->ob_bytes[it->it_index]);
        if (item != NULL)
            ++it->it_index;
        return item;
    }

    Py_DECREF(seq);
    it->it_seq = NULL;
    return NULL;
}

static PyObject *
3006
bytearrayiter_length_hint(bytesiterobject *it)
3007 3008 3009 3010 3011 3012 3013 3014 3015 3016
{
    Py_ssize_t len = 0;
    if (it->it_seq)
        len = PyByteArray_GET_SIZE(it->it_seq) - it->it_index;
    return PyLong_FromSsize_t(len);
}

PyDoc_STRVAR(length_hint_doc,
    "Private method returning an estimate of len(list(it)).");

3017 3018 3019 3020
static PyObject *
bytearrayiter_reduce(bytesiterobject *it)
{
    if (it->it_seq != NULL) {
3021
        return Py_BuildValue("N(O)n", _PyObject_GetBuiltin("iter"),
3022 3023 3024 3025 3026
                             it->it_seq, it->it_index);
    } else {
        PyObject *u = PyUnicode_FromUnicode(NULL, 0);
        if (u == NULL)
            return NULL;
3027
        return Py_BuildValue("N(N)", _PyObject_GetBuiltin("iter"), u);
3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044
    }
}

static PyObject *
bytearrayiter_setstate(bytesiterobject *it, PyObject *state)
{
    Py_ssize_t index = PyLong_AsSsize_t(state);
    if (index == -1 && PyErr_Occurred())
        return NULL;
    if (index < 0)
        index = 0;
    it->it_index = index;
    Py_RETURN_NONE;
}

PyDoc_STRVAR(setstate_doc, "Set state information for unpickling.");

3045
static PyMethodDef bytearrayiter_methods[] = {
3046
    {"__length_hint__", (PyCFunction)bytearrayiter_length_hint, METH_NOARGS,
3047
     length_hint_doc},
3048 3049 3050 3051
     {"__reduce__",      (PyCFunction)bytearrayiter_reduce, METH_NOARGS,
     reduce_doc},
    {"__setstate__",    (PyCFunction)bytearrayiter_setstate, METH_O,
     setstate_doc},
3052 3053 3054 3055 3056 3057 3058 3059 3060
    {NULL, NULL} /* sentinel */
};

PyTypeObject PyByteArrayIter_Type = {
    PyVarObject_HEAD_INIT(&PyType_Type, 0)
    "bytearray_iterator",              /* tp_name */
    sizeof(bytesiterobject),           /* tp_basicsize */
    0,                                 /* tp_itemsize */
    /* methods */
3061
    (destructor)bytearrayiter_dealloc, /* tp_dealloc */
3062 3063 3064
    0,                                 /* tp_print */
    0,                                 /* tp_getattr */
    0,                                 /* tp_setattr */
3065
    0,                                 /* tp_reserved */
3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077
    0,                                 /* tp_repr */
    0,                                 /* tp_as_number */
    0,                                 /* tp_as_sequence */
    0,                                 /* tp_as_mapping */
    0,                                 /* tp_hash */
    0,                                 /* tp_call */
    0,                                 /* tp_str */
    PyObject_GenericGetAttr,           /* tp_getattro */
    0,                                 /* tp_setattro */
    0,                                 /* tp_as_buffer */
    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
    0,                                 /* tp_doc */
3078
    (traverseproc)bytearrayiter_traverse,  /* tp_traverse */
3079 3080 3081 3082
    0,                                 /* tp_clear */
    0,                                 /* tp_richcompare */
    0,                                 /* tp_weaklistoffset */
    PyObject_SelfIter,                 /* tp_iter */
3083 3084
    (iternextfunc)bytearrayiter_next,  /* tp_iternext */
    bytearrayiter_methods,             /* tp_methods */
3085 3086 3087 3088
    0,
};

static PyObject *
3089
bytearray_iter(PyObject *seq)
3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105
{
    bytesiterobject *it;

    if (!PyByteArray_Check(seq)) {
        PyErr_BadInternalCall();
        return NULL;
    }
    it = PyObject_GC_New(bytesiterobject, &PyByteArrayIter_Type);
    if (it == NULL)
        return NULL;
    it->it_index = 0;
    Py_INCREF(seq);
    it->it_seq = (PyByteArrayObject *)seq;
    _PyObject_GC_TRACK(it);
    return (PyObject *)it;
}