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

#define PY_SSIZE_T_CLEAN
#include "Python.h"
#include "structmember.h"
#include "bytes_methods.h"
7
#include "bytesobject.h"
8
#include "pystrhex.h"
9

10 11 12 13 14
/*[clinic input]
class bytearray "PyByteArrayObject *" "&PyByteArray_Type"
[clinic start generated code]*/
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=5535b77c37a119e0]*/

15
char _PyByteArray_empty_string[] = "";
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

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);
39 40 41 42
    } else {
        PyObject *index = PyNumber_Index(arg);
        if (index == NULL) {
            PyErr_Format(PyExc_TypeError, "an integer is required");
43
            *value = -1;
44 45
            return 0;
        }
46 47 48 49 50 51 52
        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)");
53
        *value = -1;
54 55 56 57 58 59 60 61
        return 0;
    }

    *value = face_value;
    return 1;
}

static int
62
bytearray_getbuffer(PyByteArrayObject *obj, Py_buffer *view, int flags)
63 64 65
{
    void *ptr;
    if (view == NULL) {
66 67 68
        PyErr_SetString(PyExc_BufferError,
            "bytearray_getbuffer: view==NULL argument is obsolete");
        return -1;
69
    }
70
    ptr = (void *) PyByteArray_AS_STRING(obj);
71 72 73 74
    /* cannot fail if view != NULL and readonly == 0 */
    (void)PyBuffer_FillInfo(view, (PyObject*)obj, ptr, Py_SIZE(obj), 0, flags);
    obj->ob_exports++;
    return 0;
75 76 77
}

static void
78
bytearray_releasebuffer(PyByteArrayObject *obj, Py_buffer *view)
79 80 81 82
{
    obj->ob_exports--;
}

83 84 85 86 87 88 89 90 91 92 93
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;
}

94 95
#include "clinic/bytearrayobject.c.h"

96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
/* 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;
    }

117 118 119 120 121
    /* Prevent buffer overflow when setting alloc to size+1. */
    if (size == PY_SSIZE_T_MAX) {
        return PyErr_NoMemory();
    }

122 123 124 125 126 127 128 129 130 131
    new = PyObject_New(PyByteArrayObject, &PyByteArray_Type);
    if (new == NULL)
        return NULL;

    if (size == 0) {
        new->ob_bytes = NULL;
        alloc = 0;
    }
    else {
        alloc = size + 1;
132
        new->ob_bytes = PyObject_Malloc(alloc);
133 134 135 136
        if (new->ob_bytes == NULL) {
            Py_DECREF(new);
            return PyErr_NoMemory();
        }
137
        if (bytes != NULL && size > 0)
138 139 140 141 142
            memcpy(new->ob_bytes, bytes, size);
        new->ob_bytes[size] = '\0';  /* Trailing null byte */
    }
    Py_SIZE(new) = size;
    new->ob_alloc = alloc;
143
    new->ob_start = new->ob_bytes;
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
    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
168
PyByteArray_Resize(PyObject *self, Py_ssize_t requested_size)
169 170
{
    void *sval;
171
    PyByteArrayObject *obj = ((PyByteArrayObject *)self);
172 173 174 175 176
    /* All computations are done unsigned to avoid integer overflows
       (see issue #22335). */
    size_t alloc = (size_t) obj->ob_alloc;
    size_t logical_offset = (size_t) (obj->ob_start - obj->ob_bytes);
    size_t size = (size_t) requested_size;
177 178 179

    assert(self != NULL);
    assert(PyByteArray_Check(self));
180
    assert(logical_offset <= alloc);
181
    assert(requested_size >= 0);
182

183
    if (requested_size == Py_SIZE(self)) {
184 185
        return 0;
    }
186
    if (!_canresize(obj)) {
187 188 189
        return -1;
    }

190
    if (size + logical_offset + 1 <= alloc) {
191 192 193 194 195 196 197 198 199 200 201 202
        /* Current buffer is large enough to host the requested size,
           decide on a strategy. */
        if (size < alloc / 2) {
            /* Major downsize; resize down to exact size */
            alloc = size + 1;
        }
        else {
            /* Minor downsize; quick exit */
            Py_SIZE(self) = size;
            PyByteArray_AS_STRING(self)[size] = '\0'; /* Trailing null */
            return 0;
        }
203 204
    }
    else {
205 206 207 208 209 210 211 212 213
        /* Need growing, decide on a strategy */
        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;
        }
214
    }
215 216 217 218
    if (alloc > PY_SSIZE_T_MAX) {
        PyErr_NoMemory();
        return -1;
    }
219

220 221 222 223 224 225
    if (logical_offset > 0) {
        sval = PyObject_Malloc(alloc);
        if (sval == NULL) {
            PyErr_NoMemory();
            return -1;
        }
226 227
        memcpy(sval, PyByteArray_AS_STRING(self),
               Py_MIN(requested_size, Py_SIZE(self)));
228 229 230 231 232 233 234 235
        PyObject_Free(obj->ob_bytes);
    }
    else {
        sval = PyObject_Realloc(obj->ob_bytes, alloc);
        if (sval == NULL) {
            PyErr_NoMemory();
            return -1;
        }
236 237
    }

238
    obj->ob_bytes = obj->ob_start = sval;
239
    Py_SIZE(self) = size;
240 241
    obj->ob_alloc = alloc;
    obj->ob_bytes[size] = '\0'; /* Trailing null byte */
242 243 244 245 246 247 248 249 250 251 252 253

    return 0;
}

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

    va.len = -1;
    vb.len = -1;
254 255
    if (PyObject_GetBuffer(a, &va, PyBUF_SIMPLE) != 0 ||
        PyObject_GetBuffer(b, &vb, PyBUF_SIMPLE) != 0) {
256 257 258 259 260
            PyErr_Format(PyExc_TypeError, "can't concat %.100s to %.100s",
                         Py_TYPE(a)->tp_name, Py_TYPE(b)->tp_name);
            goto done;
    }

261 262 263
    if (va.len > PY_SSIZE_T_MAX - vb.len) {
        PyErr_NoMemory();
        goto done;
264 265
    }

266 267
    result = (PyByteArrayObject *) \
        PyByteArray_FromStringAndSize(NULL, va.len + vb.len);
268 269 270 271 272 273 274
    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)
275
        PyBuffer_Release(&va);
276
    if (vb.len != -1)
277
        PyBuffer_Release(&vb);
278 279 280 281 282 283
    return (PyObject *)result;
}

/* Functions stuffed into the type object */

static Py_ssize_t
284
bytearray_length(PyByteArrayObject *self)
285 286 287 288 289
{
    return Py_SIZE(self);
}

static PyObject *
290
bytearray_iconcat(PyByteArrayObject *self, PyObject *other)
291 292 293 294
{
    Py_ssize_t size;
    Py_buffer vo;

295
    if (PyObject_GetBuffer(other, &vo, PyBUF_SIMPLE) != 0) {
296 297 298 299 300
        PyErr_Format(PyExc_TypeError, "can't concat %.100s to %.100s",
                     Py_TYPE(other)->tp_name, Py_TYPE(self)->tp_name);
        return NULL;
    }

301 302
    size = Py_SIZE(self);
    if (size > PY_SSIZE_T_MAX - vo.len) {
303
        PyBuffer_Release(&vo);
304 305
        return PyErr_NoMemory();
    }
306
    if (PyByteArray_Resize((PyObject *)self, size + vo.len) < 0) {
307
        PyBuffer_Release(&vo);
308 309
        return NULL;
    }
310
    memcpy(PyByteArray_AS_STRING(self) + size, vo.buf, vo.len);
311
    PyBuffer_Release(&vo);
312 313 314 315 316
    Py_INCREF(self);
    return (PyObject *)self;
}

static PyObject *
317
bytearray_repeat(PyByteArrayObject *self, Py_ssize_t count)
318 319 320 321 322 323 324 325
{
    PyByteArrayObject *result;
    Py_ssize_t mysize;
    Py_ssize_t size;

    if (count < 0)
        count = 0;
    mysize = Py_SIZE(self);
326
    if (count > 0 && mysize > PY_SSIZE_T_MAX / count)
327
        return PyErr_NoMemory();
328
    size = mysize * count;
329 330 331 332 333 334 335 336 337 338 339 340 341 342
    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 *
343
bytearray_irepeat(PyByteArrayObject *self, Py_ssize_t count)
344 345 346
{
    Py_ssize_t mysize;
    Py_ssize_t size;
347
    char *buf;
348 349 350 351

    if (count < 0)
        count = 0;
    mysize = Py_SIZE(self);
352
    if (count > 0 && mysize > PY_SSIZE_T_MAX / count)
353
        return PyErr_NoMemory();
354
    size = mysize * count;
355
    if (PyByteArray_Resize((PyObject *)self, size) < 0)
356 357
        return NULL;

358
    buf = PyByteArray_AS_STRING(self);
359
    if (mysize == 1)
360
        memset(buf, buf[0], size);
361 362 363
    else {
        Py_ssize_t i;
        for (i = 1; i < count; i++)
364
            memcpy(buf + i*mysize, buf, mysize);
365 366 367 368 369 370 371
    }

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

static PyObject *
372
bytearray_getitem(PyByteArrayObject *self, Py_ssize_t i)
373 374 375 376 377 378 379
{
    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;
    }
380
    return PyLong_FromLong((unsigned char)(PyByteArray_AS_STRING(self)[i]));
381 382 383
}

static PyObject *
384
bytearray_subscript(PyByteArrayObject *self, PyObject *index)
385
{
386 387
    if (PyIndex_Check(index)) {
        Py_ssize_t i = PyNumber_AsSsize_t(index, PyExc_IndexError);
388 389 390 391 392 393 394 395 396 397 398

        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;
        }
399
        return PyLong_FromLong((unsigned char)(PyByteArray_AS_STRING(self)[i]));
400
    }
401
    else if (PySlice_Check(index)) {
402
        Py_ssize_t start, stop, step, slicelength, cur, i;
403
        if (PySlice_GetIndicesEx(index,
404 405 406 407 408 409 410 411
                                 PyByteArray_GET_SIZE(self),
                                 &start, &stop, &step, &slicelength) < 0) {
            return NULL;
        }

        if (slicelength <= 0)
            return PyByteArray_FromStringAndSize("", 0);
        else if (step == 1) {
412 413
            return PyByteArray_FromStringAndSize(
                PyByteArray_AS_STRING(self) + start, slicelength);
414 415 416
        }
        else {
            char *source_buf = PyByteArray_AS_STRING(self);
417
            char *result_buf;
418 419
            PyObject *result;

420 421 422
            result = PyByteArray_FromStringAndSize(NULL, slicelength);
            if (result == NULL)
                return NULL;
423

424
            result_buf = PyByteArray_AS_STRING(result);
425 426 427 428 429 430 431 432
            for (cur = start, i = 0; i < slicelength;
                 cur += step, i++) {
                     result_buf[i] = source_buf[cur];
            }
            return result;
        }
    }
    else {
433 434 435
        PyErr_Format(PyExc_TypeError,
                     "bytearray indices must be integers or slices, not %.200s",
                     Py_TYPE(index)->tp_name);
436 437 438 439
        return NULL;
    }
}

440 441 442 443 444 445 446 447
static int
bytearray_setslice_linear(PyByteArrayObject *self,
                          Py_ssize_t lo, Py_ssize_t hi,
                          char *bytes, Py_ssize_t bytes_len)
{
    Py_ssize_t avail = hi - lo;
    char *buf = PyByteArray_AS_STRING(self);
    Py_ssize_t growth = bytes_len - avail;
448
    int res = 0;
449 450
    assert(avail >= 0);

451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
    if (growth < 0) {
        if (!_canresize(self))
            return -1;

        if (lo == 0) {
            /* Shrink the buffer by advancing its logical start */
            self->ob_start -= growth;
            /*
              0   lo               hi             old_size
              |   |<----avail----->|<-----tail------>|
              |      |<-bytes_len->|<-----tail------>|
              0    new_lo         new_hi          new_size
            */
        }
        else {
            /*
              0   lo               hi               old_size
              |   |<----avail----->|<-----tomove------>|
              |   |<-bytes_len->|<-----tomove------>|
              0   lo         new_hi              new_size
            */
            memmove(buf + lo + bytes_len, buf + hi,
                    Py_SIZE(self) - hi);
        }
        if (PyByteArray_Resize((PyObject *)self,
                               Py_SIZE(self) + growth) < 0) {
            /* Issue #19578: Handling the memory allocation failure here is
               tricky here because the bytearray object has already been
               modified. Depending on growth and lo, the behaviour is
               different.

               If growth < 0 and lo != 0, the operation is completed, but a
               MemoryError is still raised and the memory block is not
484
               shrunk. Otherwise, the bytearray is restored in its previous
485
               state and a MemoryError is raised. */
486
            if (lo == 0) {
487 488
                self->ob_start += growth;
                return -1;
489
            }
490 491 492 493
            /* memmove() removed bytes, the bytearray object cannot be
               restored in its previous state. */
            Py_SIZE(self) += growth;
            res = -1;
494 495
        }
        buf = PyByteArray_AS_STRING(self);
496 497 498 499 500
    }
    else if (growth > 0) {
        if (Py_SIZE(self) > (Py_ssize_t)PY_SSIZE_T_MAX - growth) {
            PyErr_NoMemory();
            return -1;
501
        }
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516

        if (PyByteArray_Resize((PyObject *)self,
                               Py_SIZE(self) + growth) < 0) {
            return -1;
        }
        buf = PyByteArray_AS_STRING(self);
        /* Make the place for the additional bytes */
        /*
          0   lo        hi               old_size
          |   |<-avail->|<-----tomove------>|
          |   |<---bytes_len-->|<-----tomove------>|
          0   lo            new_hi              new_size
         */
        memmove(buf + lo + bytes_len, buf + hi,
                Py_SIZE(self) - lo - bytes_len);
517 518 519 520
    }

    if (bytes_len > 0)
        memcpy(buf + lo, bytes, bytes_len);
521
    return res;
522 523
}

524
static int
525
bytearray_setslice(PyByteArrayObject *self, Py_ssize_t lo, Py_ssize_t hi,
526 527
               PyObject *values)
{
528
    Py_ssize_t needed;
529 530 531 532 533 534 535 536 537 538 539
    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;
540
        err = bytearray_setslice(self, lo, hi, values);
541 542 543 544 545 546 547 548 549
        Py_DECREF(values);
        return err;
    }
    if (values == NULL) {
        /* del b[lo:hi] */
        bytes = NULL;
        needed = 0;
    }
    else {
550 551 552 553 554 555 556 557
        if (PyObject_GetBuffer(values, &vbytes, PyBUF_SIMPLE) != 0) {
            PyErr_Format(PyExc_TypeError,
                         "can't set bytearray slice from %.100s",
                         Py_TYPE(values)->tp_name);
            return -1;
        }
        needed = vbytes.len;
        bytes = vbytes.buf;
558 559 560 561 562 563 564 565 566
    }

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

567
    res = bytearray_setslice_linear(self, lo, hi, bytes, needed);
568
    if (vbytes.len != -1)
569
        PyBuffer_Release(&vbytes);
570 571 572 573
    return res;
}

static int
574
bytearray_setitem(PyByteArrayObject *self, Py_ssize_t i, PyObject *value)
575
{
576
    int ival;
577 578 579 580 581 582 583 584 585 586

    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)
587
        return bytearray_setslice(self, i, i+1, NULL);
588

589
    if (!_getbytevalue(value, &ival))
590 591
        return -1;

592
    PyByteArray_AS_STRING(self)[i] = ival;
593 594 595 596
    return 0;
}

static int
597
bytearray_ass_subscript(PyByteArrayObject *self, PyObject *index, PyObject *values)
598 599
{
    Py_ssize_t start, stop, step, slicelen, needed;
600 601
    char *buf, *bytes;
    buf = PyByteArray_AS_STRING(self);
602

603 604
    if (PyIndex_Check(index)) {
        Py_ssize_t i = PyNumber_AsSsize_t(index, PyExc_IndexError);
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624

        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 {
625 626
            int ival;
            if (!_getbytevalue(values, &ival))
627
                return -1;
628
            buf[i] = (char)ival;
629 630 631
            return 0;
        }
    }
632
    else if (PySlice_Check(index)) {
633
        if (PySlice_GetIndicesEx(index,
634 635 636 637 638 639
                                 PyByteArray_GET_SIZE(self),
                                 &start, &stop, &step, &slicelen) < 0) {
            return -1;
        }
    }
    else {
640 641 642
        PyErr_Format(PyExc_TypeError,
                     "bytearray indices must be integers or slices, not %.200s",
                      Py_TYPE(index)->tp_name);
643 644 645 646 647 648 649 650
        return -1;
    }

    if (values == NULL) {
        bytes = NULL;
        needed = 0;
    }
    else if (values == (PyObject *)self || !PyByteArray_Check(values)) {
651
        int err;
652 653 654 655 656 657
        if (PyNumber_Check(values) || PyUnicode_Check(values)) {
            PyErr_SetString(PyExc_TypeError,
                            "can assign only bytes, buffers, or iterables "
                            "of ints in range(0, 256)");
            return -1;
        }
Georg Brandl's avatar
Georg Brandl committed
658
        /* Make a copy and call this function recursively */
659 660 661
        values = PyByteArray_FromObject(values);
        if (values == NULL)
            return -1;
662
        err = bytearray_ass_subscript(self, index, values);
663 664 665 666 667
        Py_DECREF(values);
        return err;
    }
    else {
        assert(PyByteArray_Check(values));
668
        bytes = PyByteArray_AS_STRING(values);
669 670 671 672 673 674 675
        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) {
676
        return bytearray_setslice_linear(self, start, stop, bytes, needed);
677 678 679 680
    }
    else {
        if (needed == 0) {
            /* Delete slice */
681 682
            size_t cur;
            Py_ssize_t i;
683

684 685
            if (!_canresize(self))
                return -1;
686 687 688 689 690

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

691 692 693 694 695 696 697 698 699
            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;

700
                if (cur + step >= (size_t)PyByteArray_GET_SIZE(self))
701 702
                    lim = PyByteArray_GET_SIZE(self) - cur - 1;

703 704
                memmove(buf + cur - i,
                        buf + cur + 1, lim);
705 706
            }
            /* Move the tail of the bytes, in one chunk */
707
            cur = start + (size_t)slicelen*step;
708
            if (cur < (size_t)PyByteArray_GET_SIZE(self)) {
709 710
                memmove(buf + cur - slicelen,
                        buf + cur,
711 712 713 714 715 716 717 718 719 720
                        PyByteArray_GET_SIZE(self) - cur);
            }
            if (PyByteArray_Resize((PyObject *)self,
                               PyByteArray_GET_SIZE(self) - slicelen) < 0)
                return -1;

            return 0;
        }
        else {
            /* Assign slice */
721 722
            Py_ssize_t i;
            size_t cur;
723 724 725 726 727 728 729 730 731

            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++)
732
                buf[cur] = bytes[i];
733 734 735 736 737 738
            return 0;
        }
    }
}

static int
739
bytearray_init(PyByteArrayObject *self, PyObject *args, PyObject *kwds)
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
{
    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
756
    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oss:bytearray", kwlist,
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
                                     &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;
        }
778
        encoded = PyUnicode_AsEncodedString(arg, encoding, errors);
779 780 781
        if (encoded == NULL)
            return -1;
        assert(PyBytes_Check(encoded));
782
        new = bytearray_iconcat(self, encoded);
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
        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? */
798 799 800
    if (PyIndex_Check(arg)) {
        count = PyNumber_AsSsize_t(arg, PyExc_OverflowError);
        if (count == -1 && PyErr_Occurred()) {
801
            return -1;
802 803 804 805 806
        }
        if (count < 0) {
            PyErr_SetString(PyExc_ValueError, "negative count");
            return -1;
        }
807
        if (count > 0) {
808
            if (PyByteArray_Resize((PyObject *)self, count))
809
                return -1;
810
            memset(PyByteArray_AS_STRING(self), 0, count);
811 812 813 814 815 816 817 818 819 820 821 822
        }
        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;
823 824
        if (PyBuffer_ToContiguous(PyByteArray_AS_STRING(self),
            &view, size, 'C') < 0)
825
            goto fail;
826
        PyBuffer_Release(&view);
827 828
        return 0;
    fail:
829
        PyBuffer_Release(&view);
830 831 832 833 834 835 836 837 838 839 840 841 842 843
        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;
844
        int rc, value;
845 846 847 848 849 850 851 852 853 854 855 856 857

        /* 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__) */
858
        rc = _getbytevalue(item, &value);
859
        Py_DECREF(item);
860
        if (!rc)
861 862 863
            goto error;

        /* Append the byte */
864
        if (Py_SIZE(self) + 1 < self->ob_alloc) {
865
            Py_SIZE(self)++;
866 867
            PyByteArray_AS_STRING(self)[Py_SIZE(self)] = '\0';
        }
868 869
        else if (PyByteArray_Resize((PyObject *)self, Py_SIZE(self)+1) < 0)
            goto error;
870
        PyByteArray_AS_STRING(self)[Py_SIZE(self)-1] = value;
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
    }

    /* 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 *
886
bytearray_repr(PyByteArrayObject *self)
887 888 889 890
{
    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
891
    /* 15 == strlen(quote_prefix) + 2 + strlen(quote_postfix) + 1 */
892
    size_t newsize;
893
    PyObject *v;
894
    Py_ssize_t i;
895
    char *bytes;
896 897
    char c;
    char *p;
Martin v. Löwis's avatar
Martin v. Löwis committed
898 899 900 901 902
    int quote;
    char *test, *start;
    char *buffer;

    if (length > (PY_SSIZE_T_MAX - 15) / 4) {
903 904 905 906
        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
907 908

    newsize = 15 + length * 4;
909
    buffer = PyObject_Malloc(newsize);
Martin v. Löwis's avatar
Martin v. Löwis committed
910 911
    if (buffer == NULL) {
        PyErr_NoMemory();
912 913 914
        return NULL;
    }

Martin v. Löwis's avatar
Martin v. Löwis committed
915 916 917 918 919 920 921
    /* 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;
922
        }
Martin v. Löwis's avatar
Martin v. Löwis committed
923 924 925 926 927 928 929 930 931
        else if (*test == '\'')
            quote = '"';
    }

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

932
    bytes = PyByteArray_AS_STRING(self);
Martin v. Löwis's avatar
Martin v. Löwis committed
933 934 935 936
    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);
937
        c = bytes[i];
Martin v. Löwis's avatar
Martin v. Löwis committed
938 939 940 941 942 943 944 945 946 947 948 949 950
        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';
951 952
            *p++ = Py_hexdigits[(c & 0xf0) >> 4];
            *p++ = Py_hexdigits[c & 0xf];
953
        }
Martin v. Löwis's avatar
Martin v. Löwis committed
954 955 956 957 958 959 960
        else
            *p++ = c;
    }
    assert(newsize - (p - buffer) >= 1);
    *p++ = quote;
    while (*quote_postfix) {
       *p++ = *quote_postfix++;
961
    }
Martin v. Löwis's avatar
Martin v. Löwis committed
962 963

    v = PyUnicode_DecodeASCII(buffer, p - buffer, NULL);
964
    PyObject_Free(buffer);
Martin v. Löwis's avatar
Martin v. Löwis committed
965
    return v;
966 967 968
}

static PyObject *
969
bytearray_str(PyObject *op)
970
{
971 972 973 974 975 976
        if (Py_BytesWarningFlag) {
                if (PyErr_WarnEx(PyExc_BytesWarning,
                                 "str() on a bytearray instance", 1))
                        return NULL;
        }
        return bytearray_repr((PyByteArrayObject*)op);
977 978 979
}

static PyObject *
980
bytearray_richcompare(PyObject *self, PyObject *other, int op)
981 982 983 984 985
{
    Py_ssize_t self_size, other_size;
    Py_buffer self_bytes, other_bytes;
    PyObject *res;
    Py_ssize_t minsize;
986
    int cmp, rc;
987 988 989 990

    /* 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. */
991 992 993 994 995 996
    rc = PyObject_IsInstance(self, (PyObject*)&PyUnicode_Type);
    if (!rc)
        rc = PyObject_IsInstance(other, (PyObject*)&PyUnicode_Type);
    if (rc < 0)
        return NULL;
    if (rc) {
997
        if (Py_BytesWarningFlag && (op == Py_EQ || op == Py_NE)) {
998
            if (PyErr_WarnEx(PyExc_BytesWarning,
Georg Brandl's avatar
Georg Brandl committed
999
                            "Comparison between bytearray and string", 1))
1000 1001 1002
                return NULL;
        }

1003
        Py_RETURN_NOTIMPLEMENTED;
1004 1005
    }

1006
    if (PyObject_GetBuffer(self, &self_bytes, PyBUF_SIMPLE) != 0) {
1007
        PyErr_Clear();
1008
        Py_RETURN_NOTIMPLEMENTED;
1009
    }
1010
    self_size = self_bytes.len;
1011

1012
    if (PyObject_GetBuffer(other, &other_bytes, PyBUF_SIMPLE) != 0) {
1013
        PyErr_Clear();
1014
        PyBuffer_Release(&self_bytes);
1015
        Py_RETURN_NOTIMPLEMENTED;
1016
    }
1017
    other_size = other_bytes.len;
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048

    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;
1049 1050
    PyBuffer_Release(&self_bytes);
    PyBuffer_Release(&other_bytes);
1051 1052 1053 1054 1055
    Py_INCREF(res);
    return res;
}

static void
1056
bytearray_dealloc(PyByteArrayObject *self)
1057
{
Benjamin Peterson's avatar
Benjamin Peterson committed
1058 1059
    if (self->ob_exports > 0) {
        PyErr_SetString(PyExc_SystemError,
Benjamin Peterson's avatar
Benjamin Peterson committed
1060
                        "deallocated bytearray object has exported buffers");
Benjamin Peterson's avatar
Benjamin Peterson committed
1061 1062
        PyErr_Print();
    }
1063
    if (self->ob_bytes != 0) {
1064
        PyObject_Free(self->ob_bytes);
1065 1066 1067 1068 1069 1070 1071 1072
    }
    Py_TYPE(self)->tp_free((PyObject *)self);
}


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

Martin v. Löwis's avatar
Martin v. Löwis committed
1073 1074
#define FASTSEARCH fastsearch
#define STRINGLIB(F) stringlib_##F
1075
#define STRINGLIB_CHAR char
1076
#define STRINGLIB_SIZEOF_CHAR 1
1077 1078 1079
#define STRINGLIB_LEN PyByteArray_GET_SIZE
#define STRINGLIB_STR PyByteArray_AS_STRING
#define STRINGLIB_NEW PyByteArray_FromStringAndSize
1080 1081
#define STRINGLIB_ISSPACE Py_ISSPACE
#define STRINGLIB_ISLINEBREAK(x) ((x == '\n') || (x == '\r'))
1082 1083 1084 1085 1086 1087
#define STRINGLIB_CHECK_EXACT PyByteArray_CheckExact
#define STRINGLIB_MUTABLE 1

#include "stringlib/fastsearch.h"
#include "stringlib/count.h"
#include "stringlib/find.h"
1088
#include "stringlib/join.h"
1089
#include "stringlib/partition.h"
1090
#include "stringlib/split.h"
1091 1092 1093 1094
#include "stringlib/ctype.h"
#include "stringlib/transmogrify.h"


1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
static PyObject *
bytearray_find(PyByteArrayObject *self, PyObject *args)
{
    return _Py_bytes_find(PyByteArray_AS_STRING(self), PyByteArray_GET_SIZE(self), args);
}

static PyObject *
bytearray_count(PyByteArrayObject *self, PyObject *args)
{
    return _Py_bytes_count(PyByteArray_AS_STRING(self), PyByteArray_GET_SIZE(self), args);
}

1107 1108 1109 1110 1111 1112
/*[clinic input]
bytearray.clear

Remove all items from the bytearray.
[clinic start generated code]*/

1113
static PyObject *
1114
bytearray_clear_impl(PyByteArrayObject *self)
1115
/*[clinic end generated code: output=85c2fe6aede0956c input=ed6edae9de447ac4]*/
1116 1117 1118 1119 1120 1121
{
    if (PyByteArray_Resize((PyObject *)self, 0) < 0)
        return NULL;
    Py_RETURN_NONE;
}

1122 1123 1124 1125 1126 1127
/*[clinic input]
bytearray.copy

Return a copy of B.
[clinic start generated code]*/

1128
static PyObject *
1129
bytearray_copy_impl(PyByteArrayObject *self)
1130
/*[clinic end generated code: output=68cfbcfed484c132 input=6597b0c01bccaa9e]*/
1131 1132 1133 1134
{
    return PyByteArray_FromStringAndSize(PyByteArray_AS_STRING((PyObject *)self),
                                         PyByteArray_GET_SIZE(self));
}
1135

1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
static PyObject *
bytearray_index(PyByteArrayObject *self, PyObject *args)
{
    return _Py_bytes_index(PyByteArray_AS_STRING(self), PyByteArray_GET_SIZE(self), args);
}

static PyObject *
bytearray_rfind(PyByteArrayObject *self, PyObject *args)
{
    return _Py_bytes_rfind(PyByteArray_AS_STRING(self), PyByteArray_GET_SIZE(self), args);
}

static PyObject *
bytearray_rindex(PyByteArrayObject *self, PyObject *args)
{
    return _Py_bytes_rindex(PyByteArray_AS_STRING(self), PyByteArray_GET_SIZE(self), args);
}

static int
bytearray_contains(PyObject *self, PyObject *arg)
{
    return _Py_bytes_contains(PyByteArray_AS_STRING(self), PyByteArray_GET_SIZE(self), arg);
}

static PyObject *
bytearray_startswith(PyByteArrayObject *self, PyObject *args)
{
    return _Py_bytes_startswith(PyByteArray_AS_STRING(self), PyByteArray_GET_SIZE(self), args);
}

static PyObject *
bytearray_endswith(PyByteArrayObject *self, PyObject *args)
{
    return _Py_bytes_endswith(PyByteArray_AS_STRING(self), PyByteArray_GET_SIZE(self), args);
}

1172

1173 1174 1175 1176 1177 1178
/*[clinic input]
bytearray.translate

    table: object
        Translation table, which must be a bytes object of length 256.
    /
1179
    delete as deletechars: object(c_default="NULL") = b''
1180 1181 1182

Return a copy with each character mapped by the given translation table.

1183
All characters occurring in the optional argument delete are removed.
1184 1185 1186 1187
The remaining characters are mapped through the given translation table.
[clinic start generated code]*/

static PyObject *
1188
bytearray_translate_impl(PyByteArrayObject *self, PyObject *table,
1189 1190
                         PyObject *deletechars)
/*[clinic end generated code: output=b6a8f01c2a74e446 input=cfff956d4d127a9b]*/
1191
{
1192
    char *input, *output;
1193
    const char *table_chars;
1194
    Py_ssize_t i, c;
1195 1196 1197
    PyObject *input_obj = (PyObject*)self;
    const char *output_start;
    Py_ssize_t inlen;
1198
    PyObject *result = NULL;
1199 1200 1201
    int trans_table[256];
    Py_buffer vtable, vdel;

1202 1203
    if (table == Py_None) {
        table_chars = NULL;
1204
        table = NULL;
1205
    } else if (PyObject_GetBuffer(table, &vtable, PyBUF_SIMPLE) != 0) {
1206
        return NULL;
1207 1208 1209 1210
    } else {
        if (vtable.len != 256) {
            PyErr_SetString(PyExc_ValueError,
                            "translation table must be 256 characters long");
1211 1212
            PyBuffer_Release(&vtable);
            return NULL;
1213
        }
1214
        table_chars = (const char*)vtable.buf;
1215 1216
    }

1217
    if (deletechars != NULL) {
1218
        if (PyObject_GetBuffer(deletechars, &vdel, PyBUF_SIMPLE) != 0) {
1219
            if (table != NULL)
1220 1221
                PyBuffer_Release(&vtable);
            return NULL;
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
        }
    }
    else {
        vdel.buf = NULL;
        vdel.len = 0;
    }

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

1236
    if (vdel.len == 0 && table_chars != NULL) {
1237 1238 1239
        /* If no deletions are required, use faster code */
        for (i = inlen; --i >= 0; ) {
            c = Py_CHARMASK(*input++);
1240
            *output++ = table_chars[c];
1241 1242 1243
        }
        goto done;
    }
1244

1245
    if (table_chars == NULL) {
1246 1247 1248 1249
        for (i = 0; i < 256; i++)
            trans_table[i] = Py_CHARMASK(i);
    } else {
        for (i = 0; i < 256; i++)
1250
            trans_table[i] = Py_CHARMASK(table_chars[i]);
1251
    }
1252 1253 1254 1255 1256 1257 1258

    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)
1259
            *output++ = (char)trans_table[c];
1260 1261 1262
    }
    /* Fix the size of the resulting string */
    if (inlen > 0)
1263 1264 1265 1266
        if (PyByteArray_Resize(result, output - output_start) < 0) {
            Py_CLEAR(result);
            goto done;
        }
1267 1268

done:
1269
    if (table != NULL)
1270
        PyBuffer_Release(&vtable);
1271
    if (deletechars != NULL)
1272
        PyBuffer_Release(&vdel);
1273 1274 1275 1276
    return result;
}


1277 1278 1279 1280 1281
/*[clinic input]

@staticmethod
bytearray.maketrans

1282 1283
    frm: Py_buffer
    to: Py_buffer
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
    /

Return a translation table useable for the bytes or bytearray translate method.

The returned table will be one where each byte in frm is mapped to the byte at
the same position in to.

The bytes objects frm and to must be of the same length.
[clinic start generated code]*/

1294
static PyObject *
1295
bytearray_maketrans_impl(Py_buffer *frm, Py_buffer *to)
1296
/*[clinic end generated code: output=1df267d99f56b15e input=5925a81d2fbbf151]*/
1297
{
1298
    return _Py_bytes_maketrans(frm, to);
1299 1300 1301
}


1302 1303 1304
/*[clinic input]
bytearray.replace

1305 1306
    old: Py_buffer
    new: Py_buffer
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
    count: Py_ssize_t = -1
        Maximum number of occurrences to replace.
        -1 (the default value) means replace all occurrences.
    /

Return a copy with all occurrences of substring old replaced by new.

If the optional argument count is given, only the first count occurrences are
replaced.
[clinic start generated code]*/

static PyObject *
1319 1320 1321
bytearray_replace_impl(PyByteArrayObject *self, Py_buffer *old,
                       Py_buffer *new, Py_ssize_t count)
/*[clinic end generated code: output=d39884c4dc59412a input=aa379d988637c7fb]*/
1322
{
1323
    return stringlib_replace((PyObject *)self,
1324 1325
                             (const char *)old->buf, old->len,
                             (const char *)new->buf, new->len, count);
1326 1327
}

1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342
/*[clinic input]
bytearray.split

    sep: object = None
        The delimiter according which to split the bytearray.
        None (the default value) means split on ASCII whitespace characters
        (space, tab, return, newline, formfeed, vertical tab).
    maxsplit: Py_ssize_t = -1
        Maximum number of splits to do.
        -1 (the default value) means no limit.

Return a list of the sections in the bytearray, using sep as the delimiter.
[clinic start generated code]*/

static PyObject *
1343 1344 1345
bytearray_split_impl(PyByteArrayObject *self, PyObject *sep,
                     Py_ssize_t maxsplit)
/*[clinic end generated code: output=833e2cf385d9a04d input=24f82669f41bf523]*/
1346 1347
{
    Py_ssize_t len = PyByteArray_GET_SIZE(self), n;
1348
    const char *s = PyByteArray_AS_STRING(self), *sub;
1349
    PyObject *list;
1350 1351 1352 1353 1354
    Py_buffer vsub;

    if (maxsplit < 0)
        maxsplit = PY_SSIZE_T_MAX;

1355
    if (sep == Py_None)
1356
        return stringlib_split_whitespace((PyObject*) self, s, len, maxsplit);
1357

1358
    if (PyObject_GetBuffer(sep, &vsub, PyBUF_SIMPLE) != 0)
1359 1360 1361 1362
        return NULL;
    sub = vsub.buf;
    n = vsub.len;

1363 1364 1365
    list = stringlib_split(
        (PyObject*) self, s, len, sub, n, maxsplit
        );
1366
    PyBuffer_Release(&vsub);
1367 1368 1369
    return list;
}

1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
/*[clinic input]
bytearray.partition

    sep: object
    /

Partition the bytearray into three parts using the given separator.

This will search for the separator sep in the bytearray. If the separator is
found, returns a 3-tuple containing the part before the separator, the
separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original
bytearray object and two empty bytearray objects.
[clinic start generated code]*/

1386
static PyObject *
1387
bytearray_partition(PyByteArrayObject *self, PyObject *sep)
1388
/*[clinic end generated code: output=45d2525ddd35f957 input=86f89223892b70b5]*/
1389 1390 1391
{
    PyObject *bytesep, *result;

1392
    bytesep = PyByteArray_FromObject(sep);
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
    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);
1404
    return result;
1405 1406
}

1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
/*[clinic input]
bytearray.rpartition

    sep: object
    /

Partition the bytes into three parts using the given separator.

This will search for the separator sep in the bytearray, starting and the end.
If the separator is found, returns a 3-tuple containing the part before the
separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty bytearray
objects and the original bytearray object.
[clinic start generated code]*/

1423
static PyObject *
1424
bytearray_rpartition(PyByteArrayObject *self, PyObject *sep)
1425
/*[clinic end generated code: output=440de3c9426115e8 input=5f4094f2de87c8f3]*/
1426 1427 1428
{
    PyObject *bytesep, *result;

1429
    bytesep = PyByteArray_FromObject(sep);
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440
    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);
1441
    return result;
1442 1443
}

1444 1445 1446 1447 1448 1449 1450 1451 1452
/*[clinic input]
bytearray.rsplit = bytearray.split

Return a list of the sections in the bytearray, using sep as the delimiter.

Splitting is done starting at the end of the bytearray and working to the front.
[clinic start generated code]*/

static PyObject *
1453 1454 1455
bytearray_rsplit_impl(PyByteArrayObject *self, PyObject *sep,
                      Py_ssize_t maxsplit)
/*[clinic end generated code: output=a55e0b5a03cb6190 input=a68286e4dd692ffe]*/
1456 1457
{
    Py_ssize_t len = PyByteArray_GET_SIZE(self), n;
1458
    const char *s = PyByteArray_AS_STRING(self), *sub;
1459
    PyObject *list;
1460 1461 1462 1463 1464
    Py_buffer vsub;

    if (maxsplit < 0)
        maxsplit = PY_SSIZE_T_MAX;

1465
    if (sep == Py_None)
1466
        return stringlib_rsplit_whitespace((PyObject*) self, s, len, maxsplit);
1467

1468
    if (PyObject_GetBuffer(sep, &vsub, PyBUF_SIMPLE) != 0)
1469 1470 1471 1472
        return NULL;
    sub = vsub.buf;
    n = vsub.len;

1473 1474 1475
    list = stringlib_rsplit(
        (PyObject*) self, s, len, sub, n, maxsplit
        );
1476
    PyBuffer_Release(&vsub);
1477 1478 1479
    return list;
}

1480 1481 1482 1483 1484 1485 1486 1487
/*[clinic input]
bytearray.reverse

Reverse the order of the values in B in place.
[clinic start generated code]*/

static PyObject *
bytearray_reverse_impl(PyByteArrayObject *self)
1488
/*[clinic end generated code: output=9f7616f29ab309d3 input=543356319fc78557]*/
1489 1490 1491 1492 1493
{
    char swap, *head, *tail;
    Py_ssize_t i, j, n = Py_SIZE(self);

    j = n / 2;
1494
    head = PyByteArray_AS_STRING(self);
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
    tail = head + n - 1;
    for (i = 0; i < j; i++) {
        swap = *head;
        *head++ = *tail;
        *tail-- = swap;
    }

    Py_RETURN_NONE;
}

1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527

/*[python input]
class bytesvalue_converter(CConverter):
    type = 'int'
    converter = '_getbytevalue'
[python start generated code]*/
/*[python end generated code: output=da39a3ee5e6b4b0d input=29c2e7c26c212812]*/


/*[clinic input]
bytearray.insert

    index: Py_ssize_t
        The index where the value is to be inserted.
    item: bytesvalue
        The item to be inserted.
    /

Insert a single item into the bytearray before the given index.
[clinic start generated code]*/

static PyObject *
bytearray_insert_impl(PyByteArrayObject *self, Py_ssize_t index, int item)
1528
/*[clinic end generated code: output=76c775a70e7b07b7 input=b2b5d07e9de6c070]*/
1529 1530 1531
{
    Py_ssize_t n = Py_SIZE(self);
    char *buf;
1532 1533 1534

    if (n == PY_SSIZE_T_MAX) {
        PyErr_SetString(PyExc_OverflowError,
1535
                        "cannot add more objects to bytearray");
1536 1537 1538 1539
        return NULL;
    }
    if (PyByteArray_Resize((PyObject *)self, n + 1) < 0)
        return NULL;
1540
    buf = PyByteArray_AS_STRING(self);
1541

1542 1543 1544 1545
    if (index < 0) {
        index += n;
        if (index < 0)
            index = 0;
1546
    }
1547 1548 1549 1550
    if (index > n)
        index = n;
    memmove(buf + index + 1, buf + index, n - index);
    buf[index] = item;
1551 1552 1553 1554

    Py_RETURN_NONE;
}

1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
/*[clinic input]
bytearray.append

    item: bytesvalue
        The item to be appended.
    /

Append a single item to the end of the bytearray.
[clinic start generated code]*/

static PyObject *
bytearray_append_impl(PyByteArrayObject *self, int item)
1567
/*[clinic end generated code: output=a154e19ed1886cb6 input=20d6bec3d1340593]*/
1568 1569 1570 1571 1572
{
    Py_ssize_t n = Py_SIZE(self);

    if (n == PY_SSIZE_T_MAX) {
        PyErr_SetString(PyExc_OverflowError,
1573
                        "cannot add more objects to bytearray");
1574 1575 1576 1577 1578
        return NULL;
    }
    if (PyByteArray_Resize((PyObject *)self, n + 1) < 0)
        return NULL;

1579
    PyByteArray_AS_STRING(self)[n] = item;
1580 1581 1582 1583

    Py_RETURN_NONE;
}

1584 1585 1586 1587 1588 1589 1590 1591 1592 1593
/*[clinic input]
bytearray.extend

    iterable_of_ints: object
        The iterable of items to append.
    /

Append all the items from the iterator or sequence to the end of the bytearray.
[clinic start generated code]*/

1594
static PyObject *
1595
bytearray_extend(PyByteArrayObject *self, PyObject *iterable_of_ints)
1596
/*[clinic end generated code: output=98155dbe249170b1 input=c617b3a93249ba28]*/
1597
{
1598
    PyObject *it, *item, *bytearray_obj;
1599 1600 1601 1602
    Py_ssize_t buf_size = 0, len = 0;
    int value;
    char *buf;

1603
    /* bytearray_setslice code only accepts something supporting PEP 3118. */
1604 1605
    if (PyObject_CheckBuffer(iterable_of_ints)) {
        if (bytearray_setslice(self, Py_SIZE(self), Py_SIZE(self), iterable_of_ints) == -1)
1606 1607 1608 1609 1610
            return NULL;

        Py_RETURN_NONE;
    }

1611
    it = PyObject_GetIter(iterable_of_ints);
1612 1613 1614
    if (it == NULL)
        return NULL;

1615
    /* Try to determine the length of the argument. 32 is arbitrary. */
1616
    buf_size = PyObject_LengthHint(iterable_of_ints, 32);
Benjamin Peterson's avatar
Benjamin Peterson committed
1617 1618 1619 1620
    if (buf_size == -1) {
        Py_DECREF(it);
        return NULL;
    }
1621

1622
    bytearray_obj = PyByteArray_FromStringAndSize(NULL, buf_size);
1623 1624
    if (bytearray_obj == NULL) {
        Py_DECREF(it);
1625
        return NULL;
1626
    }
1627
    buf = PyByteArray_AS_STRING(bytearray_obj);
1628 1629 1630 1631 1632

    while ((item = PyIter_Next(it)) != NULL) {
        if (! _getbytevalue(item, &value)) {
            Py_DECREF(item);
            Py_DECREF(it);
1633
            Py_DECREF(bytearray_obj);
1634 1635 1636 1637 1638 1639
            return NULL;
        }
        buf[len++] = value;
        Py_DECREF(item);

        if (len >= buf_size) {
1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
            Py_ssize_t addition;
            if (len == PY_SSIZE_T_MAX) {
                Py_DECREF(it);
                Py_DECREF(bytearray_obj);
                return PyErr_NoMemory();
            }
            addition = len >> 1;
            if (addition > PY_SSIZE_T_MAX - len - 1)
                buf_size = PY_SSIZE_T_MAX;
            else
                buf_size = len + addition + 1;
1651
            if (PyByteArray_Resize((PyObject *)bytearray_obj, buf_size) < 0) {
1652
                Py_DECREF(it);
1653
                Py_DECREF(bytearray_obj);
1654 1655 1656 1657
                return NULL;
            }
            /* Recompute the `buf' pointer, since the resizing operation may
               have invalidated it. */
1658
            buf = PyByteArray_AS_STRING(bytearray_obj);
1659 1660 1661 1662 1663
        }
    }
    Py_DECREF(it);

    /* Resize down to exact size. */
1664 1665
    if (PyByteArray_Resize((PyObject *)bytearray_obj, len) < 0) {
        Py_DECREF(bytearray_obj);
1666 1667 1668
        return NULL;
    }

1669 1670
    if (bytearray_setslice(self, Py_SIZE(self), Py_SIZE(self), bytearray_obj) == -1) {
        Py_DECREF(bytearray_obj);
1671
        return NULL;
1672
    }
1673
    Py_DECREF(bytearray_obj);
1674 1675 1676 1677

    Py_RETURN_NONE;
}

1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692
/*[clinic input]
bytearray.pop

    index: Py_ssize_t = -1
        The index from where to remove the item.
        -1 (the default value) means remove the last item.
    /

Remove and return a single item from B.

If no index argument is given, will pop the last item.
[clinic start generated code]*/

static PyObject *
bytearray_pop_impl(PyByteArrayObject *self, Py_ssize_t index)
1693
/*[clinic end generated code: output=e0ccd401f8021da8 input=3591df2d06c0d237]*/
1694 1695
{
    int value;
1696
    Py_ssize_t n = Py_SIZE(self);
1697
    char *buf;
1698 1699

    if (n == 0) {
1700 1701
        PyErr_SetString(PyExc_IndexError,
                        "pop from empty bytearray");
1702 1703
        return NULL;
    }
1704 1705 1706
    if (index < 0)
        index += Py_SIZE(self);
    if (index < 0 || index >= Py_SIZE(self)) {
1707 1708 1709
        PyErr_SetString(PyExc_IndexError, "pop index out of range");
        return NULL;
    }
1710 1711
    if (!_canresize(self))
        return NULL;
1712

1713
    buf = PyByteArray_AS_STRING(self);
1714 1715
    value = buf[index];
    memmove(buf + index, buf + index + 1, n - index);
1716 1717 1718
    if (PyByteArray_Resize((PyObject *)self, n - 1) < 0)
        return NULL;

1719
    return PyLong_FromLong((unsigned char)value);
1720 1721
}

1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733
/*[clinic input]
bytearray.remove

    value: bytesvalue
        The value to remove.
    /

Remove the first occurrence of a value in the bytearray.
[clinic start generated code]*/

static PyObject *
bytearray_remove_impl(PyByteArrayObject *self, int value)
1734
/*[clinic end generated code: output=d659e37866709c13 input=121831240cd51ddf]*/
1735
{
1736
    Py_ssize_t where, n = Py_SIZE(self);
1737
    char *buf = PyByteArray_AS_STRING(self);
1738

1739 1740
    where = stringlib_find_char(buf, n, value);
    if (where < 0) {
1741
        PyErr_SetString(PyExc_ValueError, "value not found in bytearray");
1742 1743
        return NULL;
    }
1744 1745
    if (!_canresize(self))
        return NULL;
1746

1747
    memmove(buf + where, buf + where + 1, n - where);
1748 1749 1750 1751 1752 1753 1754 1755 1756
    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
1757 1758
lstrip_helper(const char *myptr, Py_ssize_t mysize,
              const void *argptr, Py_ssize_t argsize)
1759 1760
{
    Py_ssize_t i = 0;
1761
    while (i < mysize && memchr(argptr, (unsigned char) myptr[i], argsize))
1762 1763 1764 1765 1766
        i++;
    return i;
}

static Py_ssize_t
1767 1768
rstrip_helper(const char *myptr, Py_ssize_t mysize,
              const void *argptr, Py_ssize_t argsize)
1769 1770
{
    Py_ssize_t i = mysize - 1;
1771
    while (i >= 0 && memchr(argptr, (unsigned char) myptr[i], argsize))
1772 1773 1774 1775
        i--;
    return i + 1;
}

1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788
/*[clinic input]
bytearray.strip

    bytes: object = None
    /

Strip leading and trailing bytes contained in the argument.

If the argument is omitted or None, strip leading and trailing ASCII whitespace.
[clinic start generated code]*/

static PyObject *
bytearray_strip_impl(PyByteArrayObject *self, PyObject *bytes)
1789
/*[clinic end generated code: output=760412661a34ad5a input=ef7bb59b09c21d62]*/
1790 1791 1792 1793 1794 1795 1796 1797
{
    Py_ssize_t left, right, mysize, byteslen;
    char *myptr, *bytesptr;
    Py_buffer vbytes;

    if (bytes == Py_None) {
        bytesptr = "\t\n\r\f\v ";
        byteslen = 6;
1798 1799
    }
    else {
1800
        if (PyObject_GetBuffer(bytes, &vbytes, PyBUF_SIMPLE) != 0)
1801
            return NULL;
1802 1803
        bytesptr = (char *) vbytes.buf;
        byteslen = vbytes.len;
1804
    }
1805
    myptr = PyByteArray_AS_STRING(self);
1806
    mysize = Py_SIZE(self);
1807
    left = lstrip_helper(myptr, mysize, bytesptr, byteslen);
1808 1809 1810
    if (left == mysize)
        right = left;
    else
1811 1812 1813
        right = rstrip_helper(myptr, mysize, bytesptr, byteslen);
    if (bytes != Py_None)
        PyBuffer_Release(&vbytes);
1814
    return PyByteArray_FromStringAndSize(myptr + left, right - left);
1815 1816
}

1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829
/*[clinic input]
bytearray.lstrip

    bytes: object = None
    /

Strip leading bytes contained in the argument.

If the argument is omitted or None, strip leading ASCII whitespace.
[clinic start generated code]*/

static PyObject *
bytearray_lstrip_impl(PyByteArrayObject *self, PyObject *bytes)
1830
/*[clinic end generated code: output=d005c9d0ab909e66 input=80843f975dd7c480]*/
1831 1832 1833 1834 1835 1836 1837 1838
{
    Py_ssize_t left, right, mysize, byteslen;
    char *myptr, *bytesptr;
    Py_buffer vbytes;

    if (bytes == Py_None) {
        bytesptr = "\t\n\r\f\v ";
        byteslen = 6;
1839 1840
    }
    else {
1841
        if (PyObject_GetBuffer(bytes, &vbytes, PyBUF_SIMPLE) != 0)
1842
            return NULL;
1843 1844
        bytesptr = (char *) vbytes.buf;
        byteslen = vbytes.len;
1845
    }
1846
    myptr = PyByteArray_AS_STRING(self);
1847
    mysize = Py_SIZE(self);
1848
    left = lstrip_helper(myptr, mysize, bytesptr, byteslen);
1849
    right = mysize;
1850 1851
    if (bytes != Py_None)
        PyBuffer_Release(&vbytes);
1852
    return PyByteArray_FromStringAndSize(myptr + left, right - left);
1853 1854
}

1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867
/*[clinic input]
bytearray.rstrip

    bytes: object = None
    /

Strip trailing bytes contained in the argument.

If the argument is omitted or None, strip trailing ASCII whitespace.
[clinic start generated code]*/

static PyObject *
bytearray_rstrip_impl(PyByteArrayObject *self, PyObject *bytes)
1868
/*[clinic end generated code: output=030e2fbd2f7276bd input=e728b994954cfd91]*/
1869 1870 1871 1872 1873 1874 1875 1876
{
    Py_ssize_t right, mysize, byteslen;
    char *myptr, *bytesptr;
    Py_buffer vbytes;

    if (bytes == Py_None) {
        bytesptr = "\t\n\r\f\v ";
        byteslen = 6;
1877 1878
    }
    else {
1879
        if (PyObject_GetBuffer(bytes, &vbytes, PyBUF_SIMPLE) != 0)
1880
            return NULL;
1881 1882
        bytesptr = (char *) vbytes.buf;
        byteslen = vbytes.len;
1883
    }
1884
    myptr = PyByteArray_AS_STRING(self);
1885
    mysize = Py_SIZE(self);
1886 1887 1888
    right = rstrip_helper(myptr, mysize, bytesptr, byteslen);
    if (bytes != Py_None)
        PyBuffer_Release(&vbytes);
1889
    return PyByteArray_FromStringAndSize(myptr, right);
1890 1891
}

1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907
/*[clinic input]
bytearray.decode

    encoding: str(c_default="NULL") = 'utf-8'
        The encoding with which to decode the bytearray.
    errors: str(c_default="NULL") = 'strict'
        The error handling scheme to use for the handling of decoding errors.
        The default is 'strict' meaning that decoding errors raise a
        UnicodeDecodeError. Other possible values are 'ignore' and 'replace'
        as well as any other name registered with codecs.register_error that
        can handle UnicodeDecodeErrors.

Decode the bytearray using the codec registered for encoding.
[clinic start generated code]*/

static PyObject *
1908 1909 1910
bytearray_decode_impl(PyByteArrayObject *self, const char *encoding,
                      const char *errors)
/*[clinic end generated code: output=f57d43f4a00b42c5 input=f28d8f903020257b]*/
1911
{
1912 1913
    if (encoding == NULL)
        encoding = PyUnicode_GetDefaultEncoding();
1914
    return PyUnicode_FromEncodedObject((PyObject*)self, encoding, errors);
1915 1916 1917 1918 1919
}

PyDoc_STRVAR(alloc_doc,
"B.__alloc__() -> int\n\
\n\
1920
Return the number of bytes actually allocated.");
1921 1922

static PyObject *
1923
bytearray_alloc(PyByteArrayObject *self)
1924 1925 1926 1927
{
    return PyLong_FromSsize_t(self->ob_alloc);
}

1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940
/*[clinic input]
bytearray.join

    iterable_of_bytes: object
    /

Concatenate any number of bytes/bytearray objects.

The bytearray whose method is called is inserted in between each pair.

The result is returned as a new bytearray object.
[clinic start generated code]*/

1941
static PyObject *
1942
bytearray_join(PyByteArrayObject *self, PyObject *iterable_of_bytes)
1943
/*[clinic end generated code: output=a8516370bf68ae08 input=aba6b1f9b30fcb8e]*/
1944
{
1945
    return stringlib_bytes_join((PyObject*)self, iterable_of_bytes);
1946 1947
}

1948 1949 1950
/*[clinic input]
bytearray.splitlines

1951
    keepends: int(c_default="0") = False
1952 1953 1954 1955 1956 1957 1958 1959 1960

Return a list of the lines in the bytearray, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and
true.
[clinic start generated code]*/

static PyObject *
bytearray_splitlines_impl(PyByteArrayObject *self, int keepends)
1961
/*[clinic end generated code: output=4223c94b895f6ad9 input=8ccade941e5ea0bd]*/
1962
{
1963 1964 1965 1966 1967 1968
    return stringlib_splitlines(
        (PyObject*) self, PyByteArray_AS_STRING(self),
        PyByteArray_GET_SIZE(self), keepends
        );
}

1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981
/*[clinic input]
@classmethod
bytearray.fromhex

    string: unicode
    /

Create a bytearray object from a string of hexadecimal numbers.

Spaces between two numbers are accepted.
Example: bytearray.fromhex('B9 01EF') -> bytearray(b'\\xb9\\x01\\xef')
[clinic start generated code]*/

1982
static PyObject *
1983 1984
bytearray_fromhex_impl(PyTypeObject *type, PyObject *string)
/*[clinic end generated code: output=8f0f0b6d30fb3ba0 input=f033a16d1fb21f48]*/
1985
{
1986 1987 1988 1989 1990 1991
    PyObject *result = _PyBytes_FromHex(string, type == &PyByteArray_Type);
    if (type != &PyByteArray_Type && result != NULL) {
        Py_SETREF(result, PyObject_CallFunctionObjArgs((PyObject *)type,
                                                       result, NULL));
    }
    return result;
1992 1993
}

1994 1995 1996 1997 1998 1999
PyDoc_STRVAR(hex__doc__,
"B.hex() -> string\n\
\n\
Create a string of hexadecimal numbers from a bytearray object.\n\
Example: bytearray([0xb9, 0x01, 0xef]).hex() -> 'b901ef'.");

2000 2001 2002 2003 2004 2005 2006 2007
static PyObject *
bytearray_hex(PyBytesObject *self)
{
    char* argbuf = PyByteArray_AS_STRING(self);
    Py_ssize_t arglen = PyByteArray_GET_SIZE(self);
    return _Py_strhex(argbuf, arglen);
}

2008
static PyObject *
2009
_common_reduce(PyByteArrayObject *self, int proto)
2010
{
2011
    PyObject *dict;
2012
    _Py_IDENTIFIER(__dict__);
2013
    char *buf;
2014 2015

    dict = _PyObject_GetAttrId((PyObject *)self, &PyId___dict__);
2016 2017 2018 2019 2020 2021
    if (dict == NULL) {
        PyErr_Clear();
        dict = Py_None;
        Py_INCREF(dict);
    }

2022
    buf = PyByteArray_AS_STRING(self);
2023 2024 2025
    if (proto < 3) {
        /* use str based reduction for backwards compatibility with Python 2.x */
        PyObject *latin1;
2026 2027
        if (Py_SIZE(self))
            latin1 = PyUnicode_DecodeLatin1(buf, Py_SIZE(self), NULL);
2028 2029 2030 2031 2032 2033
        else
            latin1 = PyUnicode_FromString("");
        return Py_BuildValue("(O(Ns)N)", Py_TYPE(self), latin1, "latin-1", dict);
    }
    else {
        /* use more efficient byte based reduction */
2034 2035
        if (Py_SIZE(self)) {
            return Py_BuildValue("(O(y#)N)", Py_TYPE(self), buf, Py_SIZE(self), dict);
2036 2037 2038 2039 2040 2041 2042
        }
        else {
            return Py_BuildValue("(O()N)", Py_TYPE(self), dict);
        }
    }
}

2043 2044 2045 2046 2047 2048
/*[clinic input]
bytearray.__reduce__ as bytearray_reduce

Return state information for pickling.
[clinic start generated code]*/

2049
static PyObject *
2050
bytearray_reduce_impl(PyByteArrayObject *self)
2051
/*[clinic end generated code: output=52bf304086464cab input=44b5737ada62dd3f]*/
2052 2053 2054 2055
{
    return _common_reduce(self, 2);
}

2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066
/*[clinic input]
bytearray.__reduce_ex__ as bytearray_reduce_ex

    proto: int = 0
    /

Return state information for pickling.
[clinic start generated code]*/

static PyObject *
bytearray_reduce_ex_impl(PyByteArrayObject *self, int proto)
2067
/*[clinic end generated code: output=52eac33377197520 input=f129bc1a1aa151ee]*/
2068
{
2069
    return _common_reduce(self, proto);
2070 2071
}

2072 2073 2074 2075 2076 2077
/*[clinic input]
bytearray.__sizeof__ as bytearray_sizeof

Returns the size of the bytearray object in memory, in bytes.
[clinic start generated code]*/

2078
static PyObject *
2079
bytearray_sizeof_impl(PyByteArrayObject *self)
2080
/*[clinic end generated code: output=738abdd17951c427 input=e27320fd98a4bc5a]*/
2081
{
Benjamin Peterson's avatar
Benjamin Peterson committed
2082
    Py_ssize_t res;
2083

2084
    res = _PyObject_SIZE(Py_TYPE(self)) + self->ob_alloc * sizeof(char);
Benjamin Peterson's avatar
Benjamin Peterson committed
2085
    return PyLong_FromSsize_t(res);
2086 2087
}

2088 2089
static PySequenceMethods bytearray_as_sequence = {
    (lenfunc)bytearray_length,              /* sq_length */
2090
    (binaryfunc)PyByteArray_Concat,         /* sq_concat */
2091 2092 2093 2094 2095
    (ssizeargfunc)bytearray_repeat,         /* sq_repeat */
    (ssizeargfunc)bytearray_getitem,        /* sq_item */
    0,                                      /* sq_slice */
    (ssizeobjargproc)bytearray_setitem,     /* sq_ass_item */
    0,                                      /* sq_ass_slice */
2096
    (objobjproc)bytearray_contains,         /* sq_contains */
2097 2098
    (binaryfunc)bytearray_iconcat,          /* sq_inplace_concat */
    (ssizeargfunc)bytearray_irepeat,        /* sq_inplace_repeat */
2099 2100
};

2101 2102 2103 2104
static PyMappingMethods bytearray_as_mapping = {
    (lenfunc)bytearray_length,
    (binaryfunc)bytearray_subscript,
    (objobjargproc)bytearray_ass_subscript,
2105 2106
};

2107 2108 2109
static PyBufferProcs bytearray_as_buffer = {
    (getbufferproc)bytearray_getbuffer,
    (releasebufferproc)bytearray_releasebuffer,
2110 2111 2112
};

static PyMethodDef
2113 2114
bytearray_methods[] = {
    {"__alloc__", (PyCFunction)bytearray_alloc, METH_NOARGS, alloc_doc},
2115 2116 2117 2118
    BYTEARRAY_REDUCE_METHODDEF
    BYTEARRAY_REDUCE_EX_METHODDEF
    BYTEARRAY_SIZEOF_METHODDEF
    BYTEARRAY_APPEND_METHODDEF
2119 2120
    {"capitalize", (PyCFunction)stringlib_capitalize, METH_NOARGS,
     _Py_capitalize__doc__},
2121
    {"center", (PyCFunction)stringlib_center, METH_VARARGS, _Py_center__doc__},
2122 2123
    BYTEARRAY_CLEAR_METHODDEF
    BYTEARRAY_COPY_METHODDEF
2124
    {"count", (PyCFunction)bytearray_count, METH_VARARGS,
2125
     _Py_count__doc__},
2126
    BYTEARRAY_DECODE_METHODDEF
2127
    {"endswith", (PyCFunction)bytearray_endswith, METH_VARARGS,
2128
     _Py_endswith__doc__},
2129
    {"expandtabs", (PyCFunction)stringlib_expandtabs, METH_VARARGS | METH_KEYWORDS,
2130
     _Py_expandtabs__doc__},
2131
    BYTEARRAY_EXTEND_METHODDEF
2132
    {"find", (PyCFunction)bytearray_find, METH_VARARGS,
2133
     _Py_find__doc__},
2134
    BYTEARRAY_FROMHEX_METHODDEF
2135 2136
    {"hex", (PyCFunction)bytearray_hex, METH_NOARGS, hex__doc__},
    {"index", (PyCFunction)bytearray_index, METH_VARARGS, _Py_index__doc__},
2137
    BYTEARRAY_INSERT_METHODDEF
2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151
    {"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__},
2152
    BYTEARRAY_JOIN_METHODDEF
2153
    {"ljust", (PyCFunction)stringlib_ljust, METH_VARARGS, _Py_ljust__doc__},
2154
    {"lower", (PyCFunction)stringlib_lower, METH_NOARGS, _Py_lower__doc__},
2155 2156 2157 2158 2159 2160 2161
    BYTEARRAY_LSTRIP_METHODDEF
    BYTEARRAY_MAKETRANS_METHODDEF
    BYTEARRAY_PARTITION_METHODDEF
    BYTEARRAY_POP_METHODDEF
    BYTEARRAY_REMOVE_METHODDEF
    BYTEARRAY_REPLACE_METHODDEF
    BYTEARRAY_REVERSE_METHODDEF
2162 2163
    {"rfind", (PyCFunction)bytearray_rfind, METH_VARARGS, _Py_rfind__doc__},
    {"rindex", (PyCFunction)bytearray_rindex, METH_VARARGS, _Py_rindex__doc__},
2164
    {"rjust", (PyCFunction)stringlib_rjust, METH_VARARGS, _Py_rjust__doc__},
2165 2166 2167 2168 2169
    BYTEARRAY_RPARTITION_METHODDEF
    BYTEARRAY_RSPLIT_METHODDEF
    BYTEARRAY_RSTRIP_METHODDEF
    BYTEARRAY_SPLIT_METHODDEF
    BYTEARRAY_SPLITLINES_METHODDEF
2170
    {"startswith", (PyCFunction)bytearray_startswith, METH_VARARGS ,
2171
     _Py_startswith__doc__},
2172
    BYTEARRAY_STRIP_METHODDEF
2173 2174 2175
    {"swapcase", (PyCFunction)stringlib_swapcase, METH_NOARGS,
     _Py_swapcase__doc__},
    {"title", (PyCFunction)stringlib_title, METH_NOARGS, _Py_title__doc__},
2176
    BYTEARRAY_TRANSLATE_METHODDEF
2177
    {"upper", (PyCFunction)stringlib_upper, METH_NOARGS, _Py_upper__doc__},
2178
    {"zfill", (PyCFunction)stringlib_zfill, METH_VARARGS, _Py_zfill__doc__},
2179 2180 2181
    {NULL}
};

2182 2183 2184 2185 2186
static PyObject *
bytearray_mod(PyObject *v, PyObject *w)
{
    if (!PyByteArray_Check(v))
        Py_RETURN_NOTIMPLEMENTED;
2187
    return _PyBytes_FormatEx(PyByteArray_AS_STRING(v), PyByteArray_GET_SIZE(v), w, 1);
2188 2189 2190 2191 2192 2193 2194 2195 2196
}

static PyNumberMethods bytearray_as_number = {
    0,              /*nb_add*/
    0,              /*nb_subtract*/
    0,              /*nb_multiply*/
    bytearray_mod,  /*nb_remainder*/
};

2197
PyDoc_STRVAR(bytearray_doc,
2198 2199
"bytearray(iterable_of_ints) -> bytearray\n\
bytearray(string, encoding[, errors]) -> bytearray\n\
2200 2201 2202
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\
2203
\n\
2204
Construct a mutable bytearray object from:\n\
2205 2206
  - an iterable yielding integers in range(256)\n\
  - a text string encoded using the specified encoding\n\
2207
  - a bytes or a buffer object\n\
2208
  - any object implementing the buffer API.\n\
2209
  - an integer");
2210 2211


2212
static PyObject *bytearray_iter(PyObject *seq);
2213 2214 2215 2216 2217 2218

PyTypeObject PyByteArray_Type = {
    PyVarObject_HEAD_INIT(&PyType_Type, 0)
    "bytearray",
    sizeof(PyByteArrayObject),
    0,
2219
    (destructor)bytearray_dealloc,       /* tp_dealloc */
2220 2221 2222
    0,                                  /* tp_print */
    0,                                  /* tp_getattr */
    0,                                  /* tp_setattr */
2223
    0,                                  /* tp_reserved */
2224
    (reprfunc)bytearray_repr,           /* tp_repr */
2225
    &bytearray_as_number,               /* tp_as_number */
2226 2227
    &bytearray_as_sequence,             /* tp_as_sequence */
    &bytearray_as_mapping,              /* tp_as_mapping */
2228 2229
    0,                                  /* tp_hash */
    0,                                  /* tp_call */
2230
    bytearray_str,                      /* tp_str */
2231 2232
    PyObject_GenericGetAttr,            /* tp_getattro */
    0,                                  /* tp_setattro */
2233
    &bytearray_as_buffer,               /* tp_as_buffer */
2234
    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
2235
    bytearray_doc,                      /* tp_doc */
2236 2237
    0,                                  /* tp_traverse */
    0,                                  /* tp_clear */
2238
    (richcmpfunc)bytearray_richcompare, /* tp_richcompare */
2239
    0,                                  /* tp_weaklistoffset */
2240
    bytearray_iter,                     /* tp_iter */
2241
    0,                                  /* tp_iternext */
2242
    bytearray_methods,                  /* tp_methods */
2243 2244 2245 2246 2247 2248 2249
    0,                                  /* tp_members */
    0,                                  /* tp_getset */
    0,                                  /* tp_base */
    0,                                  /* tp_dict */
    0,                                  /* tp_descr_get */
    0,                                  /* tp_descr_set */
    0,                                  /* tp_dictoffset */
2250
    (initproc)bytearray_init,           /* tp_init */
2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264
    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
2265
bytearrayiter_dealloc(bytesiterobject *it)
2266 2267 2268 2269 2270 2271 2272
{
    _PyObject_GC_UNTRACK(it);
    Py_XDECREF(it->it_seq);
    PyObject_GC_Del(it);
}

static int
2273
bytearrayiter_traverse(bytesiterobject *it, visitproc visit, void *arg)
2274 2275 2276 2277 2278 2279
{
    Py_VISIT(it->it_seq);
    return 0;
}

static PyObject *
2280
bytearrayiter_next(bytesiterobject *it)
2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292
{
    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(
2293
            (unsigned char)PyByteArray_AS_STRING(seq)[it->it_index]);
2294 2295 2296 2297 2298 2299
        if (item != NULL)
            ++it->it_index;
        return item;
    }

    it->it_seq = NULL;
2300
    Py_DECREF(seq);
2301 2302 2303 2304
    return NULL;
}

static PyObject *
2305
bytearrayiter_length_hint(bytesiterobject *it)
2306 2307
{
    Py_ssize_t len = 0;
2308
    if (it->it_seq) {
2309
        len = PyByteArray_GET_SIZE(it->it_seq) - it->it_index;
2310 2311 2312 2313
        if (len < 0) {
            len = 0;
        }
    }
2314 2315 2316 2317 2318 2319
    return PyLong_FromSsize_t(len);
}

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

2320 2321 2322 2323
static PyObject *
bytearrayiter_reduce(bytesiterobject *it)
{
    if (it->it_seq != NULL) {
2324
        return Py_BuildValue("N(O)n", _PyObject_GetBuiltin("iter"),
2325 2326 2327 2328 2329
                             it->it_seq, it->it_index);
    } else {
        PyObject *u = PyUnicode_FromUnicode(NULL, 0);
        if (u == NULL)
            return NULL;
2330
        return Py_BuildValue("N(N)", _PyObject_GetBuiltin("iter"), u);
2331 2332 2333 2334 2335 2336 2337 2338 2339
    }
}

static PyObject *
bytearrayiter_setstate(bytesiterobject *it, PyObject *state)
{
    Py_ssize_t index = PyLong_AsSsize_t(state);
    if (index == -1 && PyErr_Occurred())
        return NULL;
2340 2341 2342 2343 2344 2345 2346
    if (it->it_seq != NULL) {
        if (index < 0)
            index = 0;
        else if (index > PyByteArray_GET_SIZE(it->it_seq))
            index = PyByteArray_GET_SIZE(it->it_seq); /* iterator exhausted */
        it->it_index = index;
    }
2347 2348 2349 2350 2351
    Py_RETURN_NONE;
}

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

2352
static PyMethodDef bytearrayiter_methods[] = {
2353
    {"__length_hint__", (PyCFunction)bytearrayiter_length_hint, METH_NOARGS,
2354
     length_hint_doc},
2355
     {"__reduce__",      (PyCFunction)bytearrayiter_reduce, METH_NOARGS,
2356
     bytearray_reduce__doc__},
2357 2358
    {"__setstate__",    (PyCFunction)bytearrayiter_setstate, METH_O,
     setstate_doc},
2359 2360 2361 2362 2363 2364 2365 2366 2367
    {NULL, NULL} /* sentinel */
};

PyTypeObject PyByteArrayIter_Type = {
    PyVarObject_HEAD_INIT(&PyType_Type, 0)
    "bytearray_iterator",              /* tp_name */
    sizeof(bytesiterobject),           /* tp_basicsize */
    0,                                 /* tp_itemsize */
    /* methods */
2368
    (destructor)bytearrayiter_dealloc, /* tp_dealloc */
2369 2370 2371
    0,                                 /* tp_print */
    0,                                 /* tp_getattr */
    0,                                 /* tp_setattr */
2372
    0,                                 /* tp_reserved */
2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384
    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 */
2385
    (traverseproc)bytearrayiter_traverse,  /* tp_traverse */
2386 2387 2388 2389
    0,                                 /* tp_clear */
    0,                                 /* tp_richcompare */
    0,                                 /* tp_weaklistoffset */
    PyObject_SelfIter,                 /* tp_iter */
2390 2391
    (iternextfunc)bytearrayiter_next,  /* tp_iternext */
    bytearrayiter_methods,             /* tp_methods */
2392 2393 2394 2395
    0,
};

static PyObject *
2396
bytearray_iter(PyObject *seq)
2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412
{
    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;
}