blob: 77f193cf45f873262cd3a26ba40de23cd1908b93 [file] [log] [blame]
Benjamin Peterson4116f362008-05-27 00:36:20 +00001/* bytes object implementation */
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00003#define PY_SSIZE_T_CLEAN
Christian Heimes2c9c7a52008-05-26 13:42:13 +00004
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00005#include "Python.h"
Christian Heimes2c9c7a52008-05-26 13:42:13 +00006
Gregory P. Smith60d241f2007-10-16 06:31:30 +00007#include "bytes_methods.h"
Mark Dickinsonfd24b322008-12-06 15:33:31 +00008#include <stddef.h>
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00009
Neal Norwitz2bad9702007-08-27 06:19:22 +000010static Py_ssize_t
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +000011_getbuffer(PyObject *obj, Py_buffer *view)
Guido van Rossumad7d8d12007-04-13 01:39:34 +000012{
Christian Heimes90aa7642007-12-19 02:45:37 +000013 PyBufferProcs *buffer = Py_TYPE(obj)->tp_as_buffer;
Guido van Rossumad7d8d12007-04-13 01:39:34 +000014
Gregory P. Smith60d241f2007-10-16 06:31:30 +000015 if (buffer == NULL || buffer->bf_getbuffer == NULL)
Guido van Rossuma74184e2007-08-29 04:05:57 +000016 {
Antoine Pitroud1188562010-06-09 16:38:55 +000017 PyErr_Format(PyExc_TypeError,
18 "Type %.100s doesn't support the buffer API",
19 Py_TYPE(obj)->tp_name);
20 return -1;
Guido van Rossuma74184e2007-08-29 04:05:57 +000021 }
Guido van Rossumad7d8d12007-04-13 01:39:34 +000022
Travis E. Oliphantb99f7622007-08-18 11:21:56 +000023 if (buffer->bf_getbuffer(obj, view, PyBUF_SIMPLE) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000024 return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +000025 return view->len;
Guido van Rossumad7d8d12007-04-13 01:39:34 +000026}
27
Christian Heimes2c9c7a52008-05-26 13:42:13 +000028#ifdef COUNT_ALLOCS
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000029Py_ssize_t null_strings, one_strings;
Christian Heimes2c9c7a52008-05-26 13:42:13 +000030#endif
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000031
Christian Heimes2c9c7a52008-05-26 13:42:13 +000032static PyBytesObject *characters[UCHAR_MAX + 1];
33static PyBytesObject *nullstring;
34
Mark Dickinsonfd24b322008-12-06 15:33:31 +000035/* PyBytesObject_SIZE gives the basic size of a string; any memory allocation
36 for a string of length n should request PyBytesObject_SIZE + n bytes.
37
38 Using PyBytesObject_SIZE instead of sizeof(PyBytesObject) saves
39 3 bytes per string allocation on a typical system.
40*/
41#define PyBytesObject_SIZE (offsetof(PyBytesObject, ob_sval) + 1)
42
Christian Heimes2c9c7a52008-05-26 13:42:13 +000043/*
44 For both PyBytes_FromString() and PyBytes_FromStringAndSize(), the
45 parameter `size' denotes number of characters to allocate, not counting any
46 null terminating character.
47
48 For PyBytes_FromString(), the parameter `str' points to a null-terminated
49 string containing exactly `size' bytes.
50
51 For PyBytes_FromStringAndSize(), the parameter the parameter `str' is
52 either NULL or else points to a string containing at least `size' bytes.
53 For PyBytes_FromStringAndSize(), the string in the `str' parameter does
54 not have to be null-terminated. (Therefore it is safe to construct a
55 substring by calling `PyBytes_FromStringAndSize(origstring, substrlen)'.)
56 If `str' is NULL then PyBytes_FromStringAndSize() will allocate `size+1'
57 bytes (setting the last byte to the null terminating character) and you can
58 fill in the data yourself. If `str' is non-NULL then the resulting
Antoine Pitrouf2c54842010-01-13 08:07:53 +000059 PyBytes object must be treated as immutable and you must not fill in nor
Christian Heimes2c9c7a52008-05-26 13:42:13 +000060 alter the data yourself, since the strings may be shared.
61
62 The PyObject member `op->ob_size', which denotes the number of "extra
63 items" in a variable-size object, will contain the number of bytes
64 allocated for string data, not counting the null terminating character. It
65 is therefore equal to the equal to the `size' parameter (for
66 PyBytes_FromStringAndSize()) or the length of the string in the `str'
67 parameter (for PyBytes_FromString()).
68*/
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000069PyObject *
Christian Heimes2c9c7a52008-05-26 13:42:13 +000070PyBytes_FromStringAndSize(const char *str, Py_ssize_t size)
Guido van Rossumd624f182006-04-24 13:47:05 +000071{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000072 register PyBytesObject *op;
73 if (size < 0) {
74 PyErr_SetString(PyExc_SystemError,
75 "Negative size passed to PyBytes_FromStringAndSize");
76 return NULL;
77 }
78 if (size == 0 && (op = nullstring) != NULL) {
Christian Heimes2c9c7a52008-05-26 13:42:13 +000079#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000080 null_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +000081#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082 Py_INCREF(op);
83 return (PyObject *)op;
84 }
85 if (size == 1 && str != NULL &&
86 (op = characters[*str & UCHAR_MAX]) != NULL)
87 {
Christian Heimes2c9c7a52008-05-26 13:42:13 +000088#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000089 one_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +000090#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000091 Py_INCREF(op);
92 return (PyObject *)op;
93 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +000094
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000095 if (size > PY_SSIZE_T_MAX - PyBytesObject_SIZE) {
96 PyErr_SetString(PyExc_OverflowError,
97 "byte string is too large");
98 return NULL;
99 }
Neal Norwitz3ce5d922008-08-24 07:08:55 +0000100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000101 /* Inline PyObject_NewVar */
102 op = (PyBytesObject *)PyObject_MALLOC(PyBytesObject_SIZE + size);
103 if (op == NULL)
104 return PyErr_NoMemory();
105 PyObject_INIT_VAR(op, &PyBytes_Type, size);
106 op->ob_shash = -1;
107 if (str != NULL)
108 Py_MEMCPY(op->ob_sval, str, size);
109 op->ob_sval[size] = '\0';
110 /* share short strings */
111 if (size == 0) {
112 nullstring = op;
113 Py_INCREF(op);
114 } else if (size == 1 && str != NULL) {
115 characters[*str & UCHAR_MAX] = op;
116 Py_INCREF(op);
117 }
118 return (PyObject *) op;
Guido van Rossumd624f182006-04-24 13:47:05 +0000119}
120
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000121PyObject *
122PyBytes_FromString(const char *str)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000123{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000124 register size_t size;
125 register PyBytesObject *op;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000127 assert(str != NULL);
128 size = strlen(str);
129 if (size > PY_SSIZE_T_MAX - PyBytesObject_SIZE) {
130 PyErr_SetString(PyExc_OverflowError,
131 "byte string is too long");
132 return NULL;
133 }
134 if (size == 0 && (op = nullstring) != NULL) {
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000135#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000136 null_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000137#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000138 Py_INCREF(op);
139 return (PyObject *)op;
140 }
141 if (size == 1 && (op = characters[*str & UCHAR_MAX]) != NULL) {
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000142#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000143 one_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000144#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000145 Py_INCREF(op);
146 return (PyObject *)op;
147 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000148
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000149 /* Inline PyObject_NewVar */
150 op = (PyBytesObject *)PyObject_MALLOC(PyBytesObject_SIZE + size);
151 if (op == NULL)
152 return PyErr_NoMemory();
153 PyObject_INIT_VAR(op, &PyBytes_Type, size);
154 op->ob_shash = -1;
155 Py_MEMCPY(op->ob_sval, str, size+1);
156 /* share short strings */
157 if (size == 0) {
158 nullstring = op;
159 Py_INCREF(op);
160 } else if (size == 1) {
161 characters[*str & UCHAR_MAX] = op;
162 Py_INCREF(op);
163 }
164 return (PyObject *) op;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000165}
Guido van Rossumebea9be2007-04-09 00:49:13 +0000166
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000167PyObject *
168PyBytes_FromFormatV(const char *format, va_list vargs)
169{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170 va_list count;
171 Py_ssize_t n = 0;
172 const char* f;
173 char *s;
174 PyObject* string;
Guido van Rossum343e97f2007-04-09 00:43:24 +0000175
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000176 Py_VA_COPY(count, vargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 /* step 1: figure out how large a buffer we need */
178 for (f = format; *f; f++) {
179 if (*f == '%') {
180 const char* p = f;
181 while (*++f && *f != '%' && !ISALPHA(*f))
182 ;
Guido van Rossum343e97f2007-04-09 00:43:24 +0000183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000184 /* skip the 'l' or 'z' in {%ld, %zd, %lu, %zu} since
185 * they don't affect the amount of space we reserve.
186 */
187 if ((*f == 'l' || *f == 'z') &&
188 (f[1] == 'd' || f[1] == 'u'))
189 ++f;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000190
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 switch (*f) {
192 case 'c':
193 (void)va_arg(count, int);
194 /* fall through... */
195 case '%':
196 n++;
197 break;
198 case 'd': case 'u': case 'i': case 'x':
199 (void) va_arg(count, int);
200 /* 20 bytes is enough to hold a 64-bit
201 integer. Decimal takes the most space.
202 This isn't enough for octal. */
203 n += 20;
204 break;
205 case 's':
206 s = va_arg(count, char*);
207 n += strlen(s);
208 break;
209 case 'p':
210 (void) va_arg(count, int);
211 /* maximum 64-bit pointer representation:
212 * 0xffffffffffffffff
213 * so 19 characters is enough.
214 * XXX I count 18 -- what's the extra for?
215 */
216 n += 19;
217 break;
218 default:
219 /* if we stumble upon an unknown
220 formatting code, copy the rest of
221 the format string to the output
222 string. (we cannot just skip the
223 code, since there's no way to know
224 what's in the argument list) */
225 n += strlen(p);
226 goto expand;
227 }
228 } else
229 n++;
230 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000231 expand:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000232 /* step 2: fill the buffer */
233 /* Since we've analyzed how much space we need for the worst case,
234 use sprintf directly instead of the slower PyOS_snprintf. */
235 string = PyBytes_FromStringAndSize(NULL, n);
236 if (!string)
237 return NULL;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000239 s = PyBytes_AsString(string);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000240
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000241 for (f = format; *f; f++) {
242 if (*f == '%') {
243 const char* p = f++;
244 Py_ssize_t i;
245 int longflag = 0;
246 int size_tflag = 0;
247 /* parse the width.precision part (we're only
248 interested in the precision value, if any) */
249 n = 0;
250 while (ISDIGIT(*f))
251 n = (n*10) + *f++ - '0';
252 if (*f == '.') {
253 f++;
254 n = 0;
255 while (ISDIGIT(*f))
256 n = (n*10) + *f++ - '0';
257 }
258 while (*f && *f != '%' && !ISALPHA(*f))
259 f++;
260 /* handle the long flag, but only for %ld and %lu.
261 others can be added when necessary. */
262 if (*f == 'l' && (f[1] == 'd' || f[1] == 'u')) {
263 longflag = 1;
264 ++f;
265 }
266 /* handle the size_t flag. */
267 if (*f == 'z' && (f[1] == 'd' || f[1] == 'u')) {
268 size_tflag = 1;
269 ++f;
270 }
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000272 switch (*f) {
273 case 'c':
274 *s++ = va_arg(vargs, int);
275 break;
276 case 'd':
277 if (longflag)
278 sprintf(s, "%ld", va_arg(vargs, long));
279 else if (size_tflag)
280 sprintf(s, "%" PY_FORMAT_SIZE_T "d",
281 va_arg(vargs, Py_ssize_t));
282 else
283 sprintf(s, "%d", va_arg(vargs, int));
284 s += strlen(s);
285 break;
286 case 'u':
287 if (longflag)
288 sprintf(s, "%lu",
289 va_arg(vargs, unsigned long));
290 else if (size_tflag)
291 sprintf(s, "%" PY_FORMAT_SIZE_T "u",
292 va_arg(vargs, size_t));
293 else
294 sprintf(s, "%u",
295 va_arg(vargs, unsigned int));
296 s += strlen(s);
297 break;
298 case 'i':
299 sprintf(s, "%i", va_arg(vargs, int));
300 s += strlen(s);
301 break;
302 case 'x':
303 sprintf(s, "%x", va_arg(vargs, int));
304 s += strlen(s);
305 break;
306 case 's':
307 p = va_arg(vargs, char*);
308 i = strlen(p);
309 if (n > 0 && i > n)
310 i = n;
311 Py_MEMCPY(s, p, i);
312 s += i;
313 break;
314 case 'p':
315 sprintf(s, "%p", va_arg(vargs, void*));
316 /* %p is ill-defined: ensure leading 0x. */
317 if (s[1] == 'X')
318 s[1] = 'x';
319 else if (s[1] != 'x') {
320 memmove(s+2, s, strlen(s)+1);
321 s[0] = '0';
322 s[1] = 'x';
323 }
324 s += strlen(s);
325 break;
326 case '%':
327 *s++ = '%';
328 break;
329 default:
330 strcpy(s, p);
331 s += strlen(s);
332 goto end;
333 }
334 } else
335 *s++ = *f;
336 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000337
338 end:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 _PyBytes_Resize(&string, s - PyBytes_AS_STRING(string));
340 return string;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000341}
342
343PyObject *
344PyBytes_FromFormat(const char *format, ...)
345{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000346 PyObject* ret;
347 va_list vargs;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000348
349#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000350 va_start(vargs, format);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000351#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000352 va_start(vargs);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000353#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000354 ret = PyBytes_FromFormatV(format, vargs);
355 va_end(vargs);
356 return ret;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000357}
358
359static void
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000360bytes_dealloc(PyObject *op)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000361{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000362 Py_TYPE(op)->tp_free(op);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000363}
364
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000365/* Unescape a backslash-escaped string. If unicode is non-zero,
366 the string is a u-literal. If recode_encoding is non-zero,
367 the string is UTF-8 encoded and should be re-encoded in the
368 specified encoding. */
369
370PyObject *PyBytes_DecodeEscape(const char *s,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000371 Py_ssize_t len,
372 const char *errors,
373 Py_ssize_t unicode,
374 const char *recode_encoding)
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000375{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000376 int c;
377 char *p, *buf;
378 const char *end;
379 PyObject *v;
380 Py_ssize_t newlen = recode_encoding ? 4*len:len;
381 v = PyBytes_FromStringAndSize((char *)NULL, newlen);
382 if (v == NULL)
383 return NULL;
384 p = buf = PyBytes_AsString(v);
385 end = s + len;
386 while (s < end) {
387 if (*s != '\\') {
388 non_esc:
389 if (recode_encoding && (*s & 0x80)) {
390 PyObject *u, *w;
391 char *r;
392 const char* t;
393 Py_ssize_t rn;
394 t = s;
395 /* Decode non-ASCII bytes as UTF-8. */
396 while (t < end && (*t & 0x80)) t++;
397 u = PyUnicode_DecodeUTF8(s, t - s, errors);
398 if(!u) goto failed;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000399
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 /* Recode them in target encoding. */
401 w = PyUnicode_AsEncodedString(
402 u, recode_encoding, errors);
403 Py_DECREF(u);
404 if (!w) goto failed;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000406 /* Append bytes to output buffer. */
407 assert(PyBytes_Check(w));
408 r = PyBytes_AS_STRING(w);
409 rn = PyBytes_GET_SIZE(w);
410 Py_MEMCPY(p, r, rn);
411 p += rn;
412 Py_DECREF(w);
413 s = t;
414 } else {
415 *p++ = *s++;
416 }
417 continue;
418 }
419 s++;
420 if (s==end) {
421 PyErr_SetString(PyExc_ValueError,
422 "Trailing \\ in string");
423 goto failed;
424 }
425 switch (*s++) {
426 /* XXX This assumes ASCII! */
427 case '\n': break;
428 case '\\': *p++ = '\\'; break;
429 case '\'': *p++ = '\''; break;
430 case '\"': *p++ = '\"'; break;
431 case 'b': *p++ = '\b'; break;
432 case 'f': *p++ = '\014'; break; /* FF */
433 case 't': *p++ = '\t'; break;
434 case 'n': *p++ = '\n'; break;
435 case 'r': *p++ = '\r'; break;
436 case 'v': *p++ = '\013'; break; /* VT */
437 case 'a': *p++ = '\007'; break; /* BEL, not classic C */
438 case '0': case '1': case '2': case '3':
439 case '4': case '5': case '6': case '7':
440 c = s[-1] - '0';
441 if (s < end && '0' <= *s && *s <= '7') {
442 c = (c<<3) + *s++ - '0';
443 if (s < end && '0' <= *s && *s <= '7')
444 c = (c<<3) + *s++ - '0';
445 }
446 *p++ = c;
447 break;
448 case 'x':
449 if (s+1 < end && ISXDIGIT(s[0]) && ISXDIGIT(s[1])) {
450 unsigned int x = 0;
451 c = Py_CHARMASK(*s);
452 s++;
453 if (ISDIGIT(c))
454 x = c - '0';
455 else if (ISLOWER(c))
456 x = 10 + c - 'a';
457 else
458 x = 10 + c - 'A';
459 x = x << 4;
460 c = Py_CHARMASK(*s);
461 s++;
462 if (ISDIGIT(c))
463 x += c - '0';
464 else if (ISLOWER(c))
465 x += 10 + c - 'a';
466 else
467 x += 10 + c - 'A';
468 *p++ = x;
469 break;
470 }
471 if (!errors || strcmp(errors, "strict") == 0) {
472 PyErr_SetString(PyExc_ValueError,
473 "invalid \\x escape");
474 goto failed;
475 }
476 if (strcmp(errors, "replace") == 0) {
477 *p++ = '?';
478 } else if (strcmp(errors, "ignore") == 0)
479 /* do nothing */;
480 else {
481 PyErr_Format(PyExc_ValueError,
482 "decoding error; unknown "
483 "error handling code: %.400s",
484 errors);
485 goto failed;
486 }
487 default:
488 *p++ = '\\';
489 s--;
490 goto non_esc; /* an arbitry number of unescaped
491 UTF-8 bytes may follow. */
492 }
493 }
494 if (p-buf < newlen)
495 _PyBytes_Resize(&v, p - buf);
496 return v;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000497 failed:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000498 Py_DECREF(v);
499 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000500}
501
502/* -------------------------------------------------------------------- */
503/* object api */
504
505Py_ssize_t
506PyBytes_Size(register PyObject *op)
507{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000508 if (!PyBytes_Check(op)) {
509 PyErr_Format(PyExc_TypeError,
510 "expected bytes, %.200s found", Py_TYPE(op)->tp_name);
511 return -1;
512 }
513 return Py_SIZE(op);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000514}
515
516char *
517PyBytes_AsString(register PyObject *op)
518{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000519 if (!PyBytes_Check(op)) {
520 PyErr_Format(PyExc_TypeError,
521 "expected bytes, %.200s found", Py_TYPE(op)->tp_name);
522 return NULL;
523 }
524 return ((PyBytesObject *)op)->ob_sval;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000525}
526
527int
528PyBytes_AsStringAndSize(register PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000529 register char **s,
530 register Py_ssize_t *len)
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000531{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000532 if (s == NULL) {
533 PyErr_BadInternalCall();
534 return -1;
535 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000537 if (!PyBytes_Check(obj)) {
538 PyErr_Format(PyExc_TypeError,
539 "expected bytes, %.200s found", Py_TYPE(obj)->tp_name);
540 return -1;
541 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000542
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000543 *s = PyBytes_AS_STRING(obj);
544 if (len != NULL)
545 *len = PyBytes_GET_SIZE(obj);
546 else if (strlen(*s) != (size_t)PyBytes_GET_SIZE(obj)) {
547 PyErr_SetString(PyExc_TypeError,
548 "expected bytes with no null");
549 return -1;
550 }
551 return 0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000552}
Neal Norwitz6968b052007-02-27 19:02:19 +0000553
554/* -------------------------------------------------------------------- */
555/* Methods */
556
Eric Smith0923d1d2009-04-16 20:16:10 +0000557#include "stringlib/stringdefs.h"
Neal Norwitz6968b052007-02-27 19:02:19 +0000558
559#include "stringlib/fastsearch.h"
560#include "stringlib/count.h"
561#include "stringlib/find.h"
562#include "stringlib/partition.h"
Antoine Pitrouf2c54842010-01-13 08:07:53 +0000563#include "stringlib/split.h"
Gregory P. Smith60d241f2007-10-16 06:31:30 +0000564#include "stringlib/ctype.h"
Neal Norwitz6968b052007-02-27 19:02:19 +0000565
Eric Smith0f78bff2009-11-30 01:01:42 +0000566#include "stringlib/transmogrify.h"
Neal Norwitz6968b052007-02-27 19:02:19 +0000567
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000568PyObject *
569PyBytes_Repr(PyObject *obj, int smartquotes)
Neal Norwitz6968b052007-02-27 19:02:19 +0000570{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000571 static const char *hexdigits = "0123456789abcdef";
572 register PyBytesObject* op = (PyBytesObject*) obj;
573 Py_ssize_t length = Py_SIZE(op);
Mark Dickinsoncf940c72010-08-10 18:35:01 +0000574 size_t newsize;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000575 PyObject *v;
Mark Dickinsoncf940c72010-08-10 18:35:01 +0000576 if (length > (PY_SSIZE_T_MAX - 3) / 4) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000577 PyErr_SetString(PyExc_OverflowError,
578 "bytes object is too large to make repr");
579 return NULL;
580 }
Mark Dickinsoncf940c72010-08-10 18:35:01 +0000581 newsize = 3 + 4 * length;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000582 v = PyUnicode_FromUnicode(NULL, newsize);
583 if (v == NULL) {
584 return NULL;
585 }
586 else {
587 register Py_ssize_t i;
588 register Py_UNICODE c;
589 register Py_UNICODE *p = PyUnicode_AS_UNICODE(v);
590 int quote;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000592 /* Figure out which quote to use; single is preferred */
593 quote = '\'';
594 if (smartquotes) {
595 char *test, *start;
596 start = PyBytes_AS_STRING(op);
597 for (test = start; test < start+length; ++test) {
598 if (*test == '"') {
599 quote = '\''; /* back to single */
600 goto decided;
601 }
602 else if (*test == '\'')
603 quote = '"';
604 }
605 decided:
606 ;
607 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000609 *p++ = 'b', *p++ = quote;
610 for (i = 0; i < length; i++) {
611 /* There's at least enough room for a hex escape
612 and a closing quote. */
613 assert(newsize - (p - PyUnicode_AS_UNICODE(v)) >= 5);
614 c = op->ob_sval[i];
615 if (c == quote || c == '\\')
616 *p++ = '\\', *p++ = c;
617 else if (c == '\t')
618 *p++ = '\\', *p++ = 't';
619 else if (c == '\n')
620 *p++ = '\\', *p++ = 'n';
621 else if (c == '\r')
622 *p++ = '\\', *p++ = 'r';
623 else if (c < ' ' || c >= 0x7f) {
624 *p++ = '\\';
625 *p++ = 'x';
626 *p++ = hexdigits[(c & 0xf0) >> 4];
627 *p++ = hexdigits[c & 0xf];
628 }
629 else
630 *p++ = c;
631 }
632 assert(newsize - (p - PyUnicode_AS_UNICODE(v)) >= 1);
633 *p++ = quote;
634 *p = '\0';
635 if (PyUnicode_Resize(&v, (p - PyUnicode_AS_UNICODE(v)))) {
636 Py_DECREF(v);
637 return NULL;
638 }
639 return v;
640 }
Neal Norwitz6968b052007-02-27 19:02:19 +0000641}
642
Neal Norwitz6968b052007-02-27 19:02:19 +0000643static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000644bytes_repr(PyObject *op)
Neal Norwitz6968b052007-02-27 19:02:19 +0000645{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000646 return PyBytes_Repr(op, 1);
Neal Norwitz6968b052007-02-27 19:02:19 +0000647}
648
Neal Norwitz6968b052007-02-27 19:02:19 +0000649static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000650bytes_str(PyObject *op)
Neal Norwitz6968b052007-02-27 19:02:19 +0000651{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000652 if (Py_BytesWarningFlag) {
653 if (PyErr_WarnEx(PyExc_BytesWarning,
654 "str() on a bytes instance", 1))
655 return NULL;
656 }
657 return bytes_repr(op);
Neal Norwitz6968b052007-02-27 19:02:19 +0000658}
659
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000660static Py_ssize_t
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000661bytes_length(PyBytesObject *a)
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000662{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000663 return Py_SIZE(a);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000664}
Neal Norwitz6968b052007-02-27 19:02:19 +0000665
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000666/* This is also used by PyBytes_Concat() */
667static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000668bytes_concat(PyObject *a, PyObject *b)
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000669{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000670 Py_ssize_t size;
671 Py_buffer va, vb;
672 PyObject *result = NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000674 va.len = -1;
675 vb.len = -1;
676 if (_getbuffer(a, &va) < 0 ||
677 _getbuffer(b, &vb) < 0) {
678 PyErr_Format(PyExc_TypeError, "can't concat %.100s to %.100s",
679 Py_TYPE(a)->tp_name, Py_TYPE(b)->tp_name);
680 goto done;
681 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000682
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000683 /* Optimize end cases */
684 if (va.len == 0 && PyBytes_CheckExact(b)) {
685 result = b;
686 Py_INCREF(result);
687 goto done;
688 }
689 if (vb.len == 0 && PyBytes_CheckExact(a)) {
690 result = a;
691 Py_INCREF(result);
692 goto done;
693 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000695 size = va.len + vb.len;
696 if (size < 0) {
697 PyErr_NoMemory();
698 goto done;
699 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000700
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 result = PyBytes_FromStringAndSize(NULL, size);
702 if (result != NULL) {
703 memcpy(PyBytes_AS_STRING(result), va.buf, va.len);
704 memcpy(PyBytes_AS_STRING(result) + va.len, vb.buf, vb.len);
705 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000706
707 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 if (va.len != -1)
709 PyBuffer_Release(&va);
710 if (vb.len != -1)
711 PyBuffer_Release(&vb);
712 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000713}
Neal Norwitz6968b052007-02-27 19:02:19 +0000714
715static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000716bytes_repeat(register PyBytesObject *a, register Py_ssize_t n)
Neal Norwitz6968b052007-02-27 19:02:19 +0000717{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 register Py_ssize_t i;
719 register Py_ssize_t j;
720 register Py_ssize_t size;
721 register PyBytesObject *op;
722 size_t nbytes;
723 if (n < 0)
724 n = 0;
725 /* watch out for overflows: the size can overflow int,
726 * and the # of bytes needed can overflow size_t
727 */
Mark Dickinsoncf940c72010-08-10 18:35:01 +0000728 if (n > 0 && Py_SIZE(a) > PY_SSIZE_T_MAX / n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 PyErr_SetString(PyExc_OverflowError,
730 "repeated bytes are too long");
731 return NULL;
732 }
Mark Dickinsoncf940c72010-08-10 18:35:01 +0000733 size = Py_SIZE(a) * n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 if (size == Py_SIZE(a) && PyBytes_CheckExact(a)) {
735 Py_INCREF(a);
736 return (PyObject *)a;
737 }
738 nbytes = (size_t)size;
739 if (nbytes + PyBytesObject_SIZE <= nbytes) {
740 PyErr_SetString(PyExc_OverflowError,
741 "repeated bytes are too long");
742 return NULL;
743 }
744 op = (PyBytesObject *)PyObject_MALLOC(PyBytesObject_SIZE + nbytes);
745 if (op == NULL)
746 return PyErr_NoMemory();
747 PyObject_INIT_VAR(op, &PyBytes_Type, size);
748 op->ob_shash = -1;
749 op->ob_sval[size] = '\0';
750 if (Py_SIZE(a) == 1 && n > 0) {
751 memset(op->ob_sval, a->ob_sval[0] , n);
752 return (PyObject *) op;
753 }
754 i = 0;
755 if (i < size) {
756 Py_MEMCPY(op->ob_sval, a->ob_sval, Py_SIZE(a));
757 i = Py_SIZE(a);
758 }
759 while (i < size) {
760 j = (i <= size-i) ? i : size-i;
761 Py_MEMCPY(op->ob_sval+i, op->ob_sval, j);
762 i += j;
763 }
764 return (PyObject *) op;
Neal Norwitz6968b052007-02-27 19:02:19 +0000765}
766
Guido van Rossum98297ee2007-11-06 21:34:58 +0000767static int
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000768bytes_contains(PyObject *self, PyObject *arg)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000769{
770 Py_ssize_t ival = PyNumber_AsSsize_t(arg, PyExc_ValueError);
771 if (ival == -1 && PyErr_Occurred()) {
Antoine Pitroud1188562010-06-09 16:38:55 +0000772 Py_buffer varg;
Antoine Pitrou0010d372010-08-15 17:12:55 +0000773 Py_ssize_t pos;
Antoine Pitroud1188562010-06-09 16:38:55 +0000774 PyErr_Clear();
775 if (_getbuffer(arg, &varg) < 0)
776 return -1;
777 pos = stringlib_find(PyBytes_AS_STRING(self), Py_SIZE(self),
778 varg.buf, varg.len, 0);
779 PyBuffer_Release(&varg);
780 return pos >= 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000781 }
782 if (ival < 0 || ival >= 256) {
Antoine Pitroud1188562010-06-09 16:38:55 +0000783 PyErr_SetString(PyExc_ValueError, "byte must be in range(0, 256)");
784 return -1;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000785 }
786
Antoine Pitrou0010d372010-08-15 17:12:55 +0000787 return memchr(PyBytes_AS_STRING(self), (int) ival, Py_SIZE(self)) != NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000788}
789
Neal Norwitz6968b052007-02-27 19:02:19 +0000790static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000791bytes_item(PyBytesObject *a, register Py_ssize_t i)
Neal Norwitz6968b052007-02-27 19:02:19 +0000792{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 if (i < 0 || i >= Py_SIZE(a)) {
794 PyErr_SetString(PyExc_IndexError, "index out of range");
795 return NULL;
796 }
797 return PyLong_FromLong((unsigned char)a->ob_sval[i]);
Neal Norwitz6968b052007-02-27 19:02:19 +0000798}
799
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000800static PyObject*
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000801bytes_richcompare(PyBytesObject *a, PyBytesObject *b, int op)
Neal Norwitz6968b052007-02-27 19:02:19 +0000802{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 int c;
804 Py_ssize_t len_a, len_b;
805 Py_ssize_t min_len;
806 PyObject *result;
Neal Norwitz6968b052007-02-27 19:02:19 +0000807
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 /* Make sure both arguments are strings. */
809 if (!(PyBytes_Check(a) && PyBytes_Check(b))) {
810 if (Py_BytesWarningFlag && (op == Py_EQ || op == Py_NE) &&
811 (PyObject_IsInstance((PyObject*)a,
812 (PyObject*)&PyUnicode_Type) ||
813 PyObject_IsInstance((PyObject*)b,
814 (PyObject*)&PyUnicode_Type))) {
815 if (PyErr_WarnEx(PyExc_BytesWarning,
816 "Comparison between bytes and string", 1))
817 return NULL;
818 }
819 result = Py_NotImplemented;
820 goto out;
821 }
822 if (a == b) {
823 switch (op) {
824 case Py_EQ:case Py_LE:case Py_GE:
825 result = Py_True;
826 goto out;
827 case Py_NE:case Py_LT:case Py_GT:
828 result = Py_False;
829 goto out;
830 }
831 }
832 if (op == Py_EQ) {
833 /* Supporting Py_NE here as well does not save
834 much time, since Py_NE is rarely used. */
835 if (Py_SIZE(a) == Py_SIZE(b)
836 && (a->ob_sval[0] == b->ob_sval[0]
837 && memcmp(a->ob_sval, b->ob_sval, Py_SIZE(a)) == 0)) {
838 result = Py_True;
839 } else {
840 result = Py_False;
841 }
842 goto out;
843 }
844 len_a = Py_SIZE(a); len_b = Py_SIZE(b);
845 min_len = (len_a < len_b) ? len_a : len_b;
846 if (min_len > 0) {
847 c = Py_CHARMASK(*a->ob_sval) - Py_CHARMASK(*b->ob_sval);
848 if (c==0)
849 c = memcmp(a->ob_sval, b->ob_sval, min_len);
850 } else
851 c = 0;
852 if (c == 0)
853 c = (len_a < len_b) ? -1 : (len_a > len_b) ? 1 : 0;
854 switch (op) {
855 case Py_LT: c = c < 0; break;
856 case Py_LE: c = c <= 0; break;
857 case Py_EQ: assert(0); break; /* unreachable */
858 case Py_NE: c = c != 0; break;
859 case Py_GT: c = c > 0; break;
860 case Py_GE: c = c >= 0; break;
861 default:
862 result = Py_NotImplemented;
863 goto out;
864 }
865 result = c ? Py_True : Py_False;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000866 out:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 Py_INCREF(result);
868 return result;
Neal Norwitz6968b052007-02-27 19:02:19 +0000869}
870
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000871static long
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000872bytes_hash(PyBytesObject *a)
Neal Norwitz6968b052007-02-27 19:02:19 +0000873{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000874 register Py_ssize_t len;
875 register unsigned char *p;
876 register long x;
Neal Norwitz6968b052007-02-27 19:02:19 +0000877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000878 if (a->ob_shash != -1)
879 return a->ob_shash;
880 len = Py_SIZE(a);
881 p = (unsigned char *) a->ob_sval;
882 x = *p << 7;
883 while (--len >= 0)
884 x = (1000003*x) ^ *p++;
885 x ^= Py_SIZE(a);
886 if (x == -1)
887 x = -2;
888 a->ob_shash = x;
889 return x;
Neal Norwitz6968b052007-02-27 19:02:19 +0000890}
891
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000892static PyObject*
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000893bytes_subscript(PyBytesObject* self, PyObject* item)
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000894{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000895 if (PyIndex_Check(item)) {
896 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
897 if (i == -1 && PyErr_Occurred())
898 return NULL;
899 if (i < 0)
900 i += PyBytes_GET_SIZE(self);
901 if (i < 0 || i >= PyBytes_GET_SIZE(self)) {
902 PyErr_SetString(PyExc_IndexError,
903 "index out of range");
904 return NULL;
905 }
906 return PyLong_FromLong((unsigned char)self->ob_sval[i]);
907 }
908 else if (PySlice_Check(item)) {
909 Py_ssize_t start, stop, step, slicelength, cur, i;
910 char* source_buf;
911 char* result_buf;
912 PyObject* result;
Neal Norwitz6968b052007-02-27 19:02:19 +0000913
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000914 if (PySlice_GetIndicesEx((PySliceObject*)item,
915 PyBytes_GET_SIZE(self),
916 &start, &stop, &step, &slicelength) < 0) {
917 return NULL;
918 }
Neal Norwitz6968b052007-02-27 19:02:19 +0000919
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000920 if (slicelength <= 0) {
921 return PyBytes_FromStringAndSize("", 0);
922 }
923 else if (start == 0 && step == 1 &&
924 slicelength == PyBytes_GET_SIZE(self) &&
925 PyBytes_CheckExact(self)) {
926 Py_INCREF(self);
927 return (PyObject *)self;
928 }
929 else if (step == 1) {
930 return PyBytes_FromStringAndSize(
931 PyBytes_AS_STRING(self) + start,
932 slicelength);
933 }
934 else {
935 source_buf = PyBytes_AS_STRING(self);
936 result = PyBytes_FromStringAndSize(NULL, slicelength);
937 if (result == NULL)
938 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +0000939
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000940 result_buf = PyBytes_AS_STRING(result);
941 for (cur = start, i = 0; i < slicelength;
942 cur += step, i++) {
943 result_buf[i] = source_buf[cur];
944 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000945
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000946 return result;
947 }
948 }
949 else {
950 PyErr_Format(PyExc_TypeError,
951 "byte indices must be integers, not %.200s",
952 Py_TYPE(item)->tp_name);
953 return NULL;
954 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000955}
956
957static int
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000958bytes_buffer_getbuffer(PyBytesObject *self, Py_buffer *view, int flags)
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000959{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 return PyBuffer_FillInfo(view, (PyObject*)self, (void *)self->ob_sval, Py_SIZE(self),
961 1, flags);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000962}
963
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000964static PySequenceMethods bytes_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 (lenfunc)bytes_length, /*sq_length*/
966 (binaryfunc)bytes_concat, /*sq_concat*/
967 (ssizeargfunc)bytes_repeat, /*sq_repeat*/
968 (ssizeargfunc)bytes_item, /*sq_item*/
969 0, /*sq_slice*/
970 0, /*sq_ass_item*/
971 0, /*sq_ass_slice*/
972 (objobjproc)bytes_contains /*sq_contains*/
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000973};
974
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000975static PyMappingMethods bytes_as_mapping = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 (lenfunc)bytes_length,
977 (binaryfunc)bytes_subscript,
978 0,
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000979};
980
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000981static PyBufferProcs bytes_as_buffer = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 (getbufferproc)bytes_buffer_getbuffer,
983 NULL,
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000984};
985
986
987#define LEFTSTRIP 0
988#define RIGHTSTRIP 1
989#define BOTHSTRIP 2
990
991/* Arrays indexed by above */
992static const char *stripformat[] = {"|O:lstrip", "|O:rstrip", "|O:strip"};
993
994#define STRIPNAME(i) (stripformat[i]+3)
995
Neal Norwitz6968b052007-02-27 19:02:19 +0000996PyDoc_STRVAR(split__doc__,
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000997"B.split([sep[, maxsplit]]) -> list of bytes\n\
Neal Norwitz6968b052007-02-27 19:02:19 +0000998\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +0000999Return a list of the sections in B, using sep as the delimiter.\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001000If sep is not specified or is None, B is split on ASCII whitespace\n\
1001characters (space, tab, return, newline, formfeed, vertical tab).\n\
Guido van Rossum8f950672007-09-10 16:53:45 +00001002If maxsplit is given, at most maxsplit splits are done.");
Neal Norwitz6968b052007-02-27 19:02:19 +00001003
1004static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001005bytes_split(PyBytesObject *self, PyObject *args)
Neal Norwitz6968b052007-02-27 19:02:19 +00001006{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001007 Py_ssize_t len = PyBytes_GET_SIZE(self), n;
1008 Py_ssize_t maxsplit = -1;
1009 const char *s = PyBytes_AS_STRING(self), *sub;
1010 Py_buffer vsub;
1011 PyObject *list, *subobj = Py_None;
Neal Norwitz6968b052007-02-27 19:02:19 +00001012
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001013 if (!PyArg_ParseTuple(args, "|On:split", &subobj, &maxsplit))
1014 return NULL;
1015 if (maxsplit < 0)
1016 maxsplit = PY_SSIZE_T_MAX;
1017 if (subobj == Py_None)
1018 return stringlib_split_whitespace((PyObject*) self, s, len, maxsplit);
1019 if (_getbuffer(subobj, &vsub) < 0)
1020 return NULL;
1021 sub = vsub.buf;
1022 n = vsub.len;
Guido van Rossum8f950672007-09-10 16:53:45 +00001023
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001024 list = stringlib_split((PyObject*) self, s, len, sub, n, maxsplit);
1025 PyBuffer_Release(&vsub);
1026 return list;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001027}
1028
Neal Norwitz6968b052007-02-27 19:02:19 +00001029PyDoc_STRVAR(partition__doc__,
1030"B.partition(sep) -> (head, sep, tail)\n\
1031\n\
Georg Brandl17cb8a82008-05-30 08:20:09 +00001032Search for the separator sep in B, and return the part before it,\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001033the separator itself, and the part after it. If the separator is not\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001034found, returns B and two empty bytes objects.");
Neal Norwitz6968b052007-02-27 19:02:19 +00001035
1036static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001037bytes_partition(PyBytesObject *self, PyObject *sep_obj)
Neal Norwitz6968b052007-02-27 19:02:19 +00001038{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001039 const char *sep;
1040 Py_ssize_t sep_len;
Neal Norwitz6968b052007-02-27 19:02:19 +00001041
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001042 if (PyBytes_Check(sep_obj)) {
1043 sep = PyBytes_AS_STRING(sep_obj);
1044 sep_len = PyBytes_GET_SIZE(sep_obj);
1045 }
1046 else if (PyObject_AsCharBuffer(sep_obj, &sep, &sep_len))
1047 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001048
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001049 return stringlib_partition(
1050 (PyObject*) self,
1051 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
1052 sep_obj, sep, sep_len
1053 );
Neal Norwitz6968b052007-02-27 19:02:19 +00001054}
1055
1056PyDoc_STRVAR(rpartition__doc__,
Ezio Melotti5b2b2422010-01-25 11:58:28 +00001057"B.rpartition(sep) -> (head, sep, tail)\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001058\n\
Georg Brandl17cb8a82008-05-30 08:20:09 +00001059Search for the separator sep in B, starting at the end of B,\n\
1060and return the part before it, the separator itself, and the\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00001061part after it. If the separator is not found, returns two empty\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001062bytes objects and B.");
Neal Norwitz6968b052007-02-27 19:02:19 +00001063
1064static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001065bytes_rpartition(PyBytesObject *self, PyObject *sep_obj)
Neal Norwitz6968b052007-02-27 19:02:19 +00001066{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 const char *sep;
1068 Py_ssize_t sep_len;
Neal Norwitz6968b052007-02-27 19:02:19 +00001069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 if (PyBytes_Check(sep_obj)) {
1071 sep = PyBytes_AS_STRING(sep_obj);
1072 sep_len = PyBytes_GET_SIZE(sep_obj);
1073 }
1074 else if (PyObject_AsCharBuffer(sep_obj, &sep, &sep_len))
1075 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001076
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001077 return stringlib_rpartition(
1078 (PyObject*) self,
1079 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
1080 sep_obj, sep, sep_len
1081 );
Neal Norwitz6968b052007-02-27 19:02:19 +00001082}
1083
Neal Norwitz6968b052007-02-27 19:02:19 +00001084PyDoc_STRVAR(rsplit__doc__,
Benjamin Peterson4116f362008-05-27 00:36:20 +00001085"B.rsplit([sep[, maxsplit]]) -> list of bytes\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001086\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00001087Return a list of the sections in B, using sep as the delimiter,\n\
1088starting at the end of B and working to the front.\n\
Guido van Rossum8f950672007-09-10 16:53:45 +00001089If sep is not given, B is split on ASCII whitespace characters\n\
1090(space, tab, return, newline, formfeed, vertical tab).\n\
1091If maxsplit is given, at most maxsplit splits are done.");
Neal Norwitz6968b052007-02-27 19:02:19 +00001092
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001093
Neal Norwitz6968b052007-02-27 19:02:19 +00001094static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001095bytes_rsplit(PyBytesObject *self, PyObject *args)
Neal Norwitz6968b052007-02-27 19:02:19 +00001096{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001097 Py_ssize_t len = PyBytes_GET_SIZE(self), n;
1098 Py_ssize_t maxsplit = -1;
1099 const char *s = PyBytes_AS_STRING(self), *sub;
1100 Py_buffer vsub;
1101 PyObject *list, *subobj = Py_None;
Neal Norwitz6968b052007-02-27 19:02:19 +00001102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001103 if (!PyArg_ParseTuple(args, "|On:rsplit", &subobj, &maxsplit))
1104 return NULL;
1105 if (maxsplit < 0)
1106 maxsplit = PY_SSIZE_T_MAX;
1107 if (subobj == Py_None)
1108 return stringlib_rsplit_whitespace((PyObject*) self, s, len, maxsplit);
1109 if (_getbuffer(subobj, &vsub) < 0)
1110 return NULL;
1111 sub = vsub.buf;
1112 n = vsub.len;
Guido van Rossum8f950672007-09-10 16:53:45 +00001113
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 list = stringlib_rsplit((PyObject*) self, s, len, sub, n, maxsplit);
1115 PyBuffer_Release(&vsub);
1116 return list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001117}
1118
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001119
1120PyDoc_STRVAR(join__doc__,
1121"B.join(iterable_of_bytes) -> bytes\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001122\n\
Georg Brandl17cb8a82008-05-30 08:20:09 +00001123Concatenate any number of bytes objects, with B in between each pair.\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001124Example: b'.'.join([b'ab', b'pq', b'rs']) -> b'ab.pq.rs'.");
1125
Neal Norwitz6968b052007-02-27 19:02:19 +00001126static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001127bytes_join(PyObject *self, PyObject *orig)
Neal Norwitz6968b052007-02-27 19:02:19 +00001128{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001129 char *sep = PyBytes_AS_STRING(self);
1130 const Py_ssize_t seplen = PyBytes_GET_SIZE(self);
1131 PyObject *res = NULL;
1132 char *p;
1133 Py_ssize_t seqlen = 0;
1134 size_t sz = 0;
1135 Py_ssize_t i;
1136 PyObject *seq, *item;
Neal Norwitz6968b052007-02-27 19:02:19 +00001137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001138 seq = PySequence_Fast(orig, "");
1139 if (seq == NULL) {
1140 return NULL;
1141 }
Neal Norwitz6968b052007-02-27 19:02:19 +00001142
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001143 seqlen = PySequence_Size(seq);
1144 if (seqlen == 0) {
1145 Py_DECREF(seq);
1146 return PyBytes_FromString("");
1147 }
1148 if (seqlen == 1) {
1149 item = PySequence_Fast_GET_ITEM(seq, 0);
1150 if (PyBytes_CheckExact(item)) {
1151 Py_INCREF(item);
1152 Py_DECREF(seq);
1153 return item;
1154 }
1155 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001156
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001157 /* There are at least two things to join, or else we have a subclass
1158 * of the builtin types in the sequence.
1159 * Do a pre-pass to figure out the total amount of space we'll
1160 * need (sz), and see whether all argument are bytes.
1161 */
1162 /* XXX Shouldn't we use _getbuffer() on these items instead? */
1163 for (i = 0; i < seqlen; i++) {
1164 const size_t old_sz = sz;
1165 item = PySequence_Fast_GET_ITEM(seq, i);
1166 if (!PyBytes_Check(item) && !PyByteArray_Check(item)) {
1167 PyErr_Format(PyExc_TypeError,
1168 "sequence item %zd: expected bytes,"
1169 " %.80s found",
1170 i, Py_TYPE(item)->tp_name);
1171 Py_DECREF(seq);
1172 return NULL;
1173 }
1174 sz += Py_SIZE(item);
1175 if (i != 0)
1176 sz += seplen;
1177 if (sz < old_sz || sz > PY_SSIZE_T_MAX) {
1178 PyErr_SetString(PyExc_OverflowError,
1179 "join() result is too long for bytes");
1180 Py_DECREF(seq);
1181 return NULL;
1182 }
1183 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001185 /* Allocate result space. */
1186 res = PyBytes_FromStringAndSize((char*)NULL, sz);
1187 if (res == NULL) {
1188 Py_DECREF(seq);
1189 return NULL;
1190 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001191
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001192 /* Catenate everything. */
1193 /* I'm not worried about a PyByteArray item growing because there's
1194 nowhere in this function where we release the GIL. */
1195 p = PyBytes_AS_STRING(res);
1196 for (i = 0; i < seqlen; ++i) {
1197 size_t n;
1198 char *q;
1199 if (i) {
1200 Py_MEMCPY(p, sep, seplen);
1201 p += seplen;
1202 }
1203 item = PySequence_Fast_GET_ITEM(seq, i);
1204 n = Py_SIZE(item);
1205 if (PyBytes_Check(item))
1206 q = PyBytes_AS_STRING(item);
1207 else
1208 q = PyByteArray_AS_STRING(item);
1209 Py_MEMCPY(p, q, n);
1210 p += n;
1211 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001212
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001213 Py_DECREF(seq);
1214 return res;
Neal Norwitz6968b052007-02-27 19:02:19 +00001215}
1216
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001217PyObject *
1218_PyBytes_Join(PyObject *sep, PyObject *x)
1219{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001220 assert(sep != NULL && PyBytes_Check(sep));
1221 assert(x != NULL);
1222 return bytes_join(sep, x);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001223}
1224
Antoine Pitrouf2c54842010-01-13 08:07:53 +00001225/* helper macro to fixup start/end slice values */
1226#define ADJUST_INDICES(start, end, len) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001227 if (end > len) \
1228 end = len; \
1229 else if (end < 0) { \
1230 end += len; \
1231 if (end < 0) \
1232 end = 0; \
1233 } \
1234 if (start < 0) { \
1235 start += len; \
1236 if (start < 0) \
1237 start = 0; \
1238 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001239
1240Py_LOCAL_INLINE(Py_ssize_t)
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001241bytes_find_internal(PyBytesObject *self, PyObject *args, int dir)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001242{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 PyObject *subobj;
1244 const char *sub;
1245 Py_ssize_t sub_len;
1246 Py_ssize_t start=0, end=PY_SSIZE_T_MAX;
1247 PyObject *obj_start=Py_None, *obj_end=Py_None;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001248
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001249 if (!PyArg_ParseTuple(args, "O|OO:find/rfind/index/rindex", &subobj,
1250 &obj_start, &obj_end))
1251 return -2;
1252 /* To support None in "start" and "end" arguments, meaning
1253 the same as if they were not passed.
1254 */
1255 if (obj_start != Py_None)
1256 if (!_PyEval_SliceIndex(obj_start, &start))
1257 return -2;
1258 if (obj_end != Py_None)
1259 if (!_PyEval_SliceIndex(obj_end, &end))
1260 return -2;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001261
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001262 if (PyBytes_Check(subobj)) {
1263 sub = PyBytes_AS_STRING(subobj);
1264 sub_len = PyBytes_GET_SIZE(subobj);
1265 }
1266 else if (PyObject_AsCharBuffer(subobj, &sub, &sub_len))
1267 /* XXX - the "expected a character buffer object" is pretty
1268 confusing for a non-expert. remap to something else ? */
1269 return -2;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 if (dir > 0)
1272 return stringlib_find_slice(
1273 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
1274 sub, sub_len, start, end);
1275 else
1276 return stringlib_rfind_slice(
1277 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
1278 sub, sub_len, start, end);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001279}
1280
1281
1282PyDoc_STRVAR(find__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00001283"B.find(sub[, start[, end]]) -> int\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001284\n\
Antoine Pitrouf2c54842010-01-13 08:07:53 +00001285Return the lowest index in B where substring sub is found,\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001286such that sub is contained within s[start:end]. Optional\n\
1287arguments start and end are interpreted as in slice notation.\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001288\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001289Return -1 on failure.");
1290
Neal Norwitz6968b052007-02-27 19:02:19 +00001291static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001292bytes_find(PyBytesObject *self, PyObject *args)
Neal Norwitz6968b052007-02-27 19:02:19 +00001293{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001294 Py_ssize_t result = bytes_find_internal(self, args, +1);
1295 if (result == -2)
1296 return NULL;
1297 return PyLong_FromSsize_t(result);
Neal Norwitz6968b052007-02-27 19:02:19 +00001298}
1299
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001300
1301PyDoc_STRVAR(index__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00001302"B.index(sub[, start[, end]]) -> int\n\
Alexandre Vassalotti09121e82007-12-04 05:51:13 +00001303\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001304Like B.find() but raise ValueError when the substring is not found.");
1305
Alexandre Vassalotti09121e82007-12-04 05:51:13 +00001306static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001307bytes_index(PyBytesObject *self, PyObject *args)
Alexandre Vassalotti09121e82007-12-04 05:51:13 +00001308{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001309 Py_ssize_t result = bytes_find_internal(self, args, +1);
1310 if (result == -2)
1311 return NULL;
1312 if (result == -1) {
1313 PyErr_SetString(PyExc_ValueError,
1314 "substring not found");
1315 return NULL;
1316 }
1317 return PyLong_FromSsize_t(result);
Alexandre Vassalotti09121e82007-12-04 05:51:13 +00001318}
1319
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001320
1321PyDoc_STRVAR(rfind__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00001322"B.rfind(sub[, start[, end]]) -> int\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001323\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001324Return the highest index in B where substring sub is found,\n\
1325such that sub is contained within s[start:end]. Optional\n\
1326arguments start and end are interpreted as in slice notation.\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001327\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001328Return -1 on failure.");
1329
Neal Norwitz6968b052007-02-27 19:02:19 +00001330static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001331bytes_rfind(PyBytesObject *self, PyObject *args)
Neal Norwitz6968b052007-02-27 19:02:19 +00001332{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001333 Py_ssize_t result = bytes_find_internal(self, args, -1);
1334 if (result == -2)
1335 return NULL;
1336 return PyLong_FromSsize_t(result);
Neal Norwitz6968b052007-02-27 19:02:19 +00001337}
1338
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001339
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001340PyDoc_STRVAR(rindex__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00001341"B.rindex(sub[, start[, end]]) -> int\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001342\n\
1343Like B.rfind() but raise ValueError when the substring is not found.");
1344
1345static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001346bytes_rindex(PyBytesObject *self, PyObject *args)
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001347{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 Py_ssize_t result = bytes_find_internal(self, args, -1);
1349 if (result == -2)
1350 return NULL;
1351 if (result == -1) {
1352 PyErr_SetString(PyExc_ValueError,
1353 "substring not found");
1354 return NULL;
1355 }
1356 return PyLong_FromSsize_t(result);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001357}
1358
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001359
1360Py_LOCAL_INLINE(PyObject *)
1361do_xstrip(PyBytesObject *self, int striptype, PyObject *sepobj)
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001362{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001363 Py_buffer vsep;
1364 char *s = PyBytes_AS_STRING(self);
1365 Py_ssize_t len = PyBytes_GET_SIZE(self);
1366 char *sep;
1367 Py_ssize_t seplen;
1368 Py_ssize_t i, j;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001369
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001370 if (_getbuffer(sepobj, &vsep) < 0)
1371 return NULL;
1372 sep = vsep.buf;
1373 seplen = vsep.len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001374
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001375 i = 0;
1376 if (striptype != RIGHTSTRIP) {
1377 while (i < len && memchr(sep, Py_CHARMASK(s[i]), seplen)) {
1378 i++;
1379 }
1380 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001381
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001382 j = len;
1383 if (striptype != LEFTSTRIP) {
1384 do {
1385 j--;
1386 } while (j >= i && memchr(sep, Py_CHARMASK(s[j]), seplen));
1387 j++;
1388 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 PyBuffer_Release(&vsep);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001391
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001392 if (i == 0 && j == len && PyBytes_CheckExact(self)) {
1393 Py_INCREF(self);
1394 return (PyObject*)self;
1395 }
1396 else
1397 return PyBytes_FromStringAndSize(s+i, j-i);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001398}
1399
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001400
1401Py_LOCAL_INLINE(PyObject *)
1402do_strip(PyBytesObject *self, int striptype)
1403{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001404 char *s = PyBytes_AS_STRING(self);
1405 Py_ssize_t len = PyBytes_GET_SIZE(self), i, j;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001406
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001407 i = 0;
1408 if (striptype != RIGHTSTRIP) {
1409 while (i < len && ISSPACE(s[i])) {
1410 i++;
1411 }
1412 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001413
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 j = len;
1415 if (striptype != LEFTSTRIP) {
1416 do {
1417 j--;
1418 } while (j >= i && ISSPACE(s[j]));
1419 j++;
1420 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001421
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001422 if (i == 0 && j == len && PyBytes_CheckExact(self)) {
1423 Py_INCREF(self);
1424 return (PyObject*)self;
1425 }
1426 else
1427 return PyBytes_FromStringAndSize(s+i, j-i);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001428}
1429
1430
1431Py_LOCAL_INLINE(PyObject *)
1432do_argstrip(PyBytesObject *self, int striptype, PyObject *args)
1433{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 PyObject *sep = NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 if (!PyArg_ParseTuple(args, (char *)stripformat[striptype], &sep))
1437 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001439 if (sep != NULL && sep != Py_None) {
1440 return do_xstrip(self, striptype, sep);
1441 }
1442 return do_strip(self, striptype);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001443}
1444
1445
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001446PyDoc_STRVAR(strip__doc__,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001447"B.strip([bytes]) -> bytes\n\
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001448\n\
Guido van Rossum8f950672007-09-10 16:53:45 +00001449Strip leading and trailing bytes contained in the argument.\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001450If the argument is omitted, strip trailing ASCII whitespace.");
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001451static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001452bytes_strip(PyBytesObject *self, PyObject *args)
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001453{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 if (PyTuple_GET_SIZE(args) == 0)
1455 return do_strip(self, BOTHSTRIP); /* Common case */
1456 else
1457 return do_argstrip(self, BOTHSTRIP, args);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001458}
1459
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001460
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001461PyDoc_STRVAR(lstrip__doc__,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001462"B.lstrip([bytes]) -> bytes\n\
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001463\n\
Guido van Rossum8f950672007-09-10 16:53:45 +00001464Strip leading bytes contained in the argument.\n\
1465If the argument is omitted, strip leading ASCII whitespace.");
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001466static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001467bytes_lstrip(PyBytesObject *self, PyObject *args)
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001468{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 if (PyTuple_GET_SIZE(args) == 0)
1470 return do_strip(self, LEFTSTRIP); /* Common case */
1471 else
1472 return do_argstrip(self, LEFTSTRIP, args);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001473}
1474
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001475
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001476PyDoc_STRVAR(rstrip__doc__,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001477"B.rstrip([bytes]) -> bytes\n\
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001478\n\
Guido van Rossum8f950672007-09-10 16:53:45 +00001479Strip trailing bytes contained in the argument.\n\
1480If the argument is omitted, strip trailing ASCII whitespace.");
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001481static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001482bytes_rstrip(PyBytesObject *self, PyObject *args)
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001483{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001484 if (PyTuple_GET_SIZE(args) == 0)
1485 return do_strip(self, RIGHTSTRIP); /* Common case */
1486 else
1487 return do_argstrip(self, RIGHTSTRIP, args);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001488}
Neal Norwitz6968b052007-02-27 19:02:19 +00001489
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001490
1491PyDoc_STRVAR(count__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00001492"B.count(sub[, start[, end]]) -> int\n\
Guido van Rossumd624f182006-04-24 13:47:05 +00001493\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001494Return the number of non-overlapping occurrences of substring sub in\n\
Antoine Pitrouf2c54842010-01-13 08:07:53 +00001495string B[start:end]. Optional arguments start and end are interpreted\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001496as in slice notation.");
1497
1498static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001499bytes_count(PyBytesObject *self, PyObject *args)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001500{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 PyObject *sub_obj;
1502 const char *str = PyBytes_AS_STRING(self), *sub;
1503 Py_ssize_t sub_len;
1504 Py_ssize_t start = 0, end = PY_SSIZE_T_MAX;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001505
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 if (!PyArg_ParseTuple(args, "O|O&O&:count", &sub_obj,
1507 _PyEval_SliceIndex, &start, _PyEval_SliceIndex, &end))
1508 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001510 if (PyBytes_Check(sub_obj)) {
1511 sub = PyBytes_AS_STRING(sub_obj);
1512 sub_len = PyBytes_GET_SIZE(sub_obj);
1513 }
1514 else if (PyObject_AsCharBuffer(sub_obj, &sub, &sub_len))
1515 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001517 ADJUST_INDICES(start, end, PyBytes_GET_SIZE(self));
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001518
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001519 return PyLong_FromSsize_t(
1520 stringlib_count(str + start, end - start, sub, sub_len, PY_SSIZE_T_MAX)
1521 );
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001522}
1523
1524
1525PyDoc_STRVAR(translate__doc__,
1526"B.translate(table[, deletechars]) -> bytes\n\
1527\n\
1528Return a copy of B, where all characters occurring in the\n\
1529optional argument deletechars are removed, and the remaining\n\
1530characters have been mapped through the given translation\n\
1531table, which must be a bytes object of length 256.");
1532
1533static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001534bytes_translate(PyBytesObject *self, PyObject *args)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001535{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001536 register char *input, *output;
1537 const char *table;
1538 register Py_ssize_t i, c, changed = 0;
1539 PyObject *input_obj = (PyObject*)self;
1540 const char *output_start, *del_table=NULL;
1541 Py_ssize_t inlen, tablen, dellen = 0;
1542 PyObject *result;
1543 int trans_table[256];
1544 PyObject *tableobj, *delobj = NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001546 if (!PyArg_UnpackTuple(args, "translate", 1, 2,
1547 &tableobj, &delobj))
1548 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001549
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001550 if (PyBytes_Check(tableobj)) {
1551 table = PyBytes_AS_STRING(tableobj);
1552 tablen = PyBytes_GET_SIZE(tableobj);
1553 }
1554 else if (tableobj == Py_None) {
1555 table = NULL;
1556 tablen = 256;
1557 }
1558 else if (PyObject_AsCharBuffer(tableobj, &table, &tablen))
1559 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001560
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001561 if (tablen != 256) {
1562 PyErr_SetString(PyExc_ValueError,
1563 "translation table must be 256 characters long");
1564 return NULL;
1565 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 if (delobj != NULL) {
1568 if (PyBytes_Check(delobj)) {
1569 del_table = PyBytes_AS_STRING(delobj);
1570 dellen = PyBytes_GET_SIZE(delobj);
1571 }
1572 else if (PyObject_AsCharBuffer(delobj, &del_table, &dellen))
1573 return NULL;
1574 }
1575 else {
1576 del_table = NULL;
1577 dellen = 0;
1578 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001579
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001580 inlen = PyBytes_GET_SIZE(input_obj);
1581 result = PyBytes_FromStringAndSize((char *)NULL, inlen);
1582 if (result == NULL)
1583 return NULL;
1584 output_start = output = PyBytes_AsString(result);
1585 input = PyBytes_AS_STRING(input_obj);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001586
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001587 if (dellen == 0 && table != NULL) {
1588 /* If no deletions are required, use faster code */
1589 for (i = inlen; --i >= 0; ) {
1590 c = Py_CHARMASK(*input++);
1591 if (Py_CHARMASK((*output++ = table[c])) != c)
1592 changed = 1;
1593 }
1594 if (changed || !PyBytes_CheckExact(input_obj))
1595 return result;
1596 Py_DECREF(result);
1597 Py_INCREF(input_obj);
1598 return input_obj;
1599 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001600
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001601 if (table == NULL) {
1602 for (i = 0; i < 256; i++)
1603 trans_table[i] = Py_CHARMASK(i);
1604 } else {
1605 for (i = 0; i < 256; i++)
1606 trans_table[i] = Py_CHARMASK(table[i]);
1607 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 for (i = 0; i < dellen; i++)
1610 trans_table[(int) Py_CHARMASK(del_table[i])] = -1;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001611
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 for (i = inlen; --i >= 0; ) {
1613 c = Py_CHARMASK(*input++);
1614 if (trans_table[c] != -1)
1615 if (Py_CHARMASK(*output++ = (char)trans_table[c]) == c)
1616 continue;
1617 changed = 1;
1618 }
1619 if (!changed && PyBytes_CheckExact(input_obj)) {
1620 Py_DECREF(result);
1621 Py_INCREF(input_obj);
1622 return input_obj;
1623 }
1624 /* Fix the size of the resulting string */
1625 if (inlen > 0)
1626 _PyBytes_Resize(&result, output - output_start);
1627 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001628}
1629
1630
Georg Brandlabc38772009-04-12 15:51:51 +00001631static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001632bytes_maketrans(PyObject *null, PyObject *args)
Georg Brandlabc38772009-04-12 15:51:51 +00001633{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001634 return _Py_bytes_maketrans(args);
Georg Brandlabc38772009-04-12 15:51:51 +00001635}
1636
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001637/* find and count characters and substrings */
1638
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001639#define findchar(target, target_len, c) \
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001640 ((char *)memchr((const void *)(target), c, target_len))
1641
1642/* String ops must return a string. */
1643/* If the object is subclass of string, create a copy */
1644Py_LOCAL(PyBytesObject *)
1645return_self(PyBytesObject *self)
1646{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001647 if (PyBytes_CheckExact(self)) {
1648 Py_INCREF(self);
1649 return self;
1650 }
1651 return (PyBytesObject *)PyBytes_FromStringAndSize(
1652 PyBytes_AS_STRING(self),
1653 PyBytes_GET_SIZE(self));
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001654}
1655
1656Py_LOCAL_INLINE(Py_ssize_t)
Antoine Pitrou0010d372010-08-15 17:12:55 +00001657countchar(const char *target, Py_ssize_t target_len, char c, Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001658{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001659 Py_ssize_t count=0;
1660 const char *start=target;
1661 const char *end=target+target_len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001662
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001663 while ( (start=findchar(start, end-start, c)) != NULL ) {
1664 count++;
1665 if (count >= maxcount)
1666 break;
1667 start += 1;
1668 }
1669 return count;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001670}
1671
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001672
1673/* Algorithms for different cases of string replacement */
1674
1675/* len(self)>=1, from="", len(to)>=1, maxcount>=1 */
1676Py_LOCAL(PyBytesObject *)
1677replace_interleave(PyBytesObject *self,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001678 const char *to_s, Py_ssize_t to_len,
1679 Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001680{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001681 char *self_s, *result_s;
1682 Py_ssize_t self_len, result_len;
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001683 Py_ssize_t count, i;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001684 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001685
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001686 self_len = PyBytes_GET_SIZE(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001687
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001688 /* 1 at the end plus 1 after every character;
1689 count = min(maxcount, self_len + 1) */
1690 if (maxcount <= self_len)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001691 count = maxcount;
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001692 else
1693 /* Can't overflow: self_len + 1 <= maxcount <= PY_SSIZE_T_MAX. */
1694 count = self_len + 1;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001695
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001696 /* Check for overflow */
1697 /* result_len = count * to_len + self_len; */
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001698 assert(count > 0);
1699 if (to_len > (PY_SSIZE_T_MAX - self_len) / count) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001700 PyErr_SetString(PyExc_OverflowError,
1701 "replacement bytes are too long");
1702 return NULL;
1703 }
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001704 result_len = count * to_len + self_len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001705
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001706 if (! (result = (PyBytesObject *)
1707 PyBytes_FromStringAndSize(NULL, result_len)) )
1708 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001710 self_s = PyBytes_AS_STRING(self);
1711 result_s = PyBytes_AS_STRING(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001713 /* TODO: special case single character, which doesn't need memcpy */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001714
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001715 /* Lay the first one down (guaranteed this will occur) */
1716 Py_MEMCPY(result_s, to_s, to_len);
1717 result_s += to_len;
1718 count -= 1;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001719
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001720 for (i=0; i<count; i++) {
1721 *result_s++ = *self_s++;
1722 Py_MEMCPY(result_s, to_s, to_len);
1723 result_s += to_len;
1724 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001725
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001726 /* Copy the rest of the original string */
1727 Py_MEMCPY(result_s, self_s, self_len-i);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001728
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001729 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001730}
1731
1732/* Special case for deleting a single character */
1733/* len(self)>=1, len(from)==1, to="", maxcount>=1 */
1734Py_LOCAL(PyBytesObject *)
1735replace_delete_single_character(PyBytesObject *self,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001736 char from_c, Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001737{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001738 char *self_s, *result_s;
1739 char *start, *next, *end;
1740 Py_ssize_t self_len, result_len;
1741 Py_ssize_t count;
1742 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001743
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001744 self_len = PyBytes_GET_SIZE(self);
1745 self_s = PyBytes_AS_STRING(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001746
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001747 count = countchar(self_s, self_len, from_c, maxcount);
1748 if (count == 0) {
1749 return return_self(self);
1750 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001751
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001752 result_len = self_len - count; /* from_len == 1 */
1753 assert(result_len>=0);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001755 if ( (result = (PyBytesObject *)
1756 PyBytes_FromStringAndSize(NULL, result_len)) == NULL)
1757 return NULL;
1758 result_s = PyBytes_AS_STRING(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001759
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001760 start = self_s;
1761 end = self_s + self_len;
1762 while (count-- > 0) {
1763 next = findchar(start, end-start, from_c);
1764 if (next == NULL)
1765 break;
1766 Py_MEMCPY(result_s, start, next-start);
1767 result_s += (next-start);
1768 start = next+1;
1769 }
1770 Py_MEMCPY(result_s, start, end-start);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001771
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001772 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001773}
1774
1775/* len(self)>=1, len(from)>=2, to="", maxcount>=1 */
1776
1777Py_LOCAL(PyBytesObject *)
1778replace_delete_substring(PyBytesObject *self,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001779 const char *from_s, Py_ssize_t from_len,
1780 Py_ssize_t maxcount) {
1781 char *self_s, *result_s;
1782 char *start, *next, *end;
1783 Py_ssize_t self_len, result_len;
1784 Py_ssize_t count, offset;
1785 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001786
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001787 self_len = PyBytes_GET_SIZE(self);
1788 self_s = PyBytes_AS_STRING(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001789
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001790 count = stringlib_count(self_s, self_len,
1791 from_s, from_len,
1792 maxcount);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001793
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 if (count == 0) {
1795 /* no matches */
1796 return return_self(self);
1797 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001798
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001799 result_len = self_len - (count * from_len);
1800 assert (result_len>=0);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 if ( (result = (PyBytesObject *)
1803 PyBytes_FromStringAndSize(NULL, result_len)) == NULL )
1804 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001805
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 result_s = PyBytes_AS_STRING(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001807
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001808 start = self_s;
1809 end = self_s + self_len;
1810 while (count-- > 0) {
1811 offset = stringlib_find(start, end-start,
1812 from_s, from_len,
1813 0);
1814 if (offset == -1)
1815 break;
1816 next = start + offset;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001817
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001818 Py_MEMCPY(result_s, start, next-start);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001819
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001820 result_s += (next-start);
1821 start = next+from_len;
1822 }
1823 Py_MEMCPY(result_s, start, end-start);
1824 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001825}
1826
1827/* len(self)>=1, len(from)==len(to)==1, maxcount>=1 */
1828Py_LOCAL(PyBytesObject *)
1829replace_single_character_in_place(PyBytesObject *self,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001830 char from_c, char to_c,
1831 Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001832{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001833 char *self_s, *result_s, *start, *end, *next;
1834 Py_ssize_t self_len;
1835 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001836
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001837 /* The result string will be the same size */
1838 self_s = PyBytes_AS_STRING(self);
1839 self_len = PyBytes_GET_SIZE(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001840
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001841 next = findchar(self_s, self_len, from_c);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001842
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001843 if (next == NULL) {
1844 /* No matches; return the original string */
1845 return return_self(self);
1846 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001848 /* Need to make a new string */
1849 result = (PyBytesObject *) PyBytes_FromStringAndSize(NULL, self_len);
1850 if (result == NULL)
1851 return NULL;
1852 result_s = PyBytes_AS_STRING(result);
1853 Py_MEMCPY(result_s, self_s, self_len);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001855 /* change everything in-place, starting with this one */
1856 start = result_s + (next-self_s);
1857 *start = to_c;
1858 start++;
1859 end = result_s + self_len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001860
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001861 while (--maxcount > 0) {
1862 next = findchar(start, end-start, from_c);
1863 if (next == NULL)
1864 break;
1865 *next = to_c;
1866 start = next+1;
1867 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001868
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001869 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001870}
1871
1872/* len(self)>=1, len(from)==len(to)>=2, maxcount>=1 */
1873Py_LOCAL(PyBytesObject *)
1874replace_substring_in_place(PyBytesObject *self,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001875 const char *from_s, Py_ssize_t from_len,
1876 const char *to_s, Py_ssize_t to_len,
1877 Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001878{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001879 char *result_s, *start, *end;
1880 char *self_s;
1881 Py_ssize_t self_len, offset;
1882 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001884 /* The result string will be the same size */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001885
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001886 self_s = PyBytes_AS_STRING(self);
1887 self_len = PyBytes_GET_SIZE(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001888
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001889 offset = stringlib_find(self_s, self_len,
1890 from_s, from_len,
1891 0);
1892 if (offset == -1) {
1893 /* No matches; return the original string */
1894 return return_self(self);
1895 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001896
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001897 /* Need to make a new string */
1898 result = (PyBytesObject *) PyBytes_FromStringAndSize(NULL, self_len);
1899 if (result == NULL)
1900 return NULL;
1901 result_s = PyBytes_AS_STRING(result);
1902 Py_MEMCPY(result_s, self_s, self_len);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001903
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001904 /* change everything in-place, starting with this one */
1905 start = result_s + offset;
1906 Py_MEMCPY(start, to_s, from_len);
1907 start += from_len;
1908 end = result_s + self_len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001909
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001910 while ( --maxcount > 0) {
1911 offset = stringlib_find(start, end-start,
1912 from_s, from_len,
1913 0);
1914 if (offset==-1)
1915 break;
1916 Py_MEMCPY(start+offset, to_s, from_len);
1917 start += offset+from_len;
1918 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001919
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001920 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001921}
1922
1923/* len(self)>=1, len(from)==1, len(to)>=2, maxcount>=1 */
1924Py_LOCAL(PyBytesObject *)
1925replace_single_character(PyBytesObject *self,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001926 char from_c,
1927 const char *to_s, Py_ssize_t to_len,
1928 Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001929{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001930 char *self_s, *result_s;
1931 char *start, *next, *end;
1932 Py_ssize_t self_len, result_len;
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001933 Py_ssize_t count;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001934 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001935
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001936 self_s = PyBytes_AS_STRING(self);
1937 self_len = PyBytes_GET_SIZE(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001938
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001939 count = countchar(self_s, self_len, from_c, maxcount);
1940 if (count == 0) {
1941 /* no matches, return unchanged */
1942 return return_self(self);
1943 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001944
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001945 /* use the difference between current and new, hence the "-1" */
1946 /* result_len = self_len + count * (to_len-1) */
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001947 assert(count > 0);
1948 if (to_len - 1 > (PY_SSIZE_T_MAX - self_len) / count) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001949 PyErr_SetString(PyExc_OverflowError,
1950 "replacement bytes are too long");
1951 return NULL;
1952 }
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001953 result_len = self_len + count * (to_len - 1);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001954
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001955 if ( (result = (PyBytesObject *)
1956 PyBytes_FromStringAndSize(NULL, result_len)) == NULL)
1957 return NULL;
1958 result_s = PyBytes_AS_STRING(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001959
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001960 start = self_s;
1961 end = self_s + self_len;
1962 while (count-- > 0) {
1963 next = findchar(start, end-start, from_c);
1964 if (next == NULL)
1965 break;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001966
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001967 if (next == start) {
1968 /* replace with the 'to' */
1969 Py_MEMCPY(result_s, to_s, to_len);
1970 result_s += to_len;
1971 start += 1;
1972 } else {
1973 /* copy the unchanged old then the 'to' */
1974 Py_MEMCPY(result_s, start, next-start);
1975 result_s += (next-start);
1976 Py_MEMCPY(result_s, to_s, to_len);
1977 result_s += to_len;
1978 start = next+1;
1979 }
1980 }
1981 /* Copy the remainder of the remaining string */
1982 Py_MEMCPY(result_s, start, end-start);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001983
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001984 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001985}
1986
1987/* len(self)>=1, len(from)>=2, len(to)>=2, maxcount>=1 */
1988Py_LOCAL(PyBytesObject *)
1989replace_substring(PyBytesObject *self,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001990 const char *from_s, Py_ssize_t from_len,
1991 const char *to_s, Py_ssize_t to_len,
1992 Py_ssize_t maxcount) {
1993 char *self_s, *result_s;
1994 char *start, *next, *end;
1995 Py_ssize_t self_len, result_len;
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001996 Py_ssize_t count, offset;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001997 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001998
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001999 self_s = PyBytes_AS_STRING(self);
2000 self_len = PyBytes_GET_SIZE(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002001
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002002 count = stringlib_count(self_s, self_len,
2003 from_s, from_len,
2004 maxcount);
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002005
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002006 if (count == 0) {
2007 /* no matches, return unchanged */
2008 return return_self(self);
2009 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002010
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002011 /* Check for overflow */
2012 /* result_len = self_len + count * (to_len-from_len) */
Mark Dickinsoncf940c72010-08-10 18:35:01 +00002013 assert(count > 0);
2014 if (to_len - from_len > (PY_SSIZE_T_MAX - self_len) / count) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002015 PyErr_SetString(PyExc_OverflowError,
2016 "replacement bytes are too long");
2017 return NULL;
2018 }
Mark Dickinsoncf940c72010-08-10 18:35:01 +00002019 result_len = self_len + count * (to_len-from_len);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002020
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002021 if ( (result = (PyBytesObject *)
2022 PyBytes_FromStringAndSize(NULL, result_len)) == NULL)
2023 return NULL;
2024 result_s = PyBytes_AS_STRING(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002025
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002026 start = self_s;
2027 end = self_s + self_len;
2028 while (count-- > 0) {
2029 offset = stringlib_find(start, end-start,
2030 from_s, from_len,
2031 0);
2032 if (offset == -1)
2033 break;
2034 next = start+offset;
2035 if (next == start) {
2036 /* replace with the 'to' */
2037 Py_MEMCPY(result_s, to_s, to_len);
2038 result_s += to_len;
2039 start += from_len;
2040 } else {
2041 /* copy the unchanged old then the 'to' */
2042 Py_MEMCPY(result_s, start, next-start);
2043 result_s += (next-start);
2044 Py_MEMCPY(result_s, to_s, to_len);
2045 result_s += to_len;
2046 start = next+from_len;
2047 }
2048 }
2049 /* Copy the remainder of the remaining string */
2050 Py_MEMCPY(result_s, start, end-start);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002051
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002052 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002053}
2054
2055
2056Py_LOCAL(PyBytesObject *)
2057replace(PyBytesObject *self,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002058 const char *from_s, Py_ssize_t from_len,
2059 const char *to_s, Py_ssize_t to_len,
2060 Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002061{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002062 if (maxcount < 0) {
2063 maxcount = PY_SSIZE_T_MAX;
2064 } else if (maxcount == 0 || PyBytes_GET_SIZE(self) == 0) {
2065 /* nothing to do; return the original string */
2066 return return_self(self);
2067 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002068
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002069 if (maxcount == 0 ||
2070 (from_len == 0 && to_len == 0)) {
2071 /* nothing to do; return the original string */
2072 return return_self(self);
2073 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002074
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002075 /* Handle zero-length special cases */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002076
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002077 if (from_len == 0) {
2078 /* insert the 'to' string everywhere. */
2079 /* >>> "Python".replace("", ".") */
2080 /* '.P.y.t.h.o.n.' */
2081 return replace_interleave(self, to_s, to_len, maxcount);
2082 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002084 /* Except for "".replace("", "A") == "A" there is no way beyond this */
2085 /* point for an empty self string to generate a non-empty string */
2086 /* Special case so the remaining code always gets a non-empty string */
2087 if (PyBytes_GET_SIZE(self) == 0) {
2088 return return_self(self);
2089 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002090
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002091 if (to_len == 0) {
2092 /* delete all occurrences of 'from' string */
2093 if (from_len == 1) {
2094 return replace_delete_single_character(
2095 self, from_s[0], maxcount);
2096 } else {
2097 return replace_delete_substring(self, from_s,
2098 from_len, maxcount);
2099 }
2100 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002101
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002102 /* Handle special case where both strings have the same length */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002103
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002104 if (from_len == to_len) {
2105 if (from_len == 1) {
2106 return replace_single_character_in_place(
2107 self,
2108 from_s[0],
2109 to_s[0],
2110 maxcount);
2111 } else {
2112 return replace_substring_in_place(
2113 self, from_s, from_len, to_s, to_len,
2114 maxcount);
2115 }
2116 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002118 /* Otherwise use the more generic algorithms */
2119 if (from_len == 1) {
2120 return replace_single_character(self, from_s[0],
2121 to_s, to_len, maxcount);
2122 } else {
2123 /* len('from')>=2, len('to')>=1 */
2124 return replace_substring(self, from_s, from_len, to_s, to_len,
2125 maxcount);
2126 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002127}
2128
2129PyDoc_STRVAR(replace__doc__,
2130"B.replace(old, new[, count]) -> bytes\n\
2131\n\
2132Return a copy of B with all occurrences of subsection\n\
2133old replaced by new. If the optional argument count is\n\
Senthil Kumaran77210b42010-08-09 08:56:25 +00002134positive, only the first count occurrences are replaced. A\n\
Senthil Kumaranf2de1ff2010-08-09 09:03:57 +00002135negative value of count replaces all occurrences");
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002136
2137static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002138bytes_replace(PyBytesObject *self, PyObject *args)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002139{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002140 Py_ssize_t count = -1;
2141 PyObject *from, *to;
2142 const char *from_s, *to_s;
2143 Py_ssize_t from_len, to_len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002145 if (!PyArg_ParseTuple(args, "OO|n:replace", &from, &to, &count))
2146 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002147
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002148 if (PyBytes_Check(from)) {
2149 from_s = PyBytes_AS_STRING(from);
2150 from_len = PyBytes_GET_SIZE(from);
2151 }
2152 else if (PyObject_AsCharBuffer(from, &from_s, &from_len))
2153 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002155 if (PyBytes_Check(to)) {
2156 to_s = PyBytes_AS_STRING(to);
2157 to_len = PyBytes_GET_SIZE(to);
2158 }
2159 else if (PyObject_AsCharBuffer(to, &to_s, &to_len))
2160 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002161
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002162 return (PyObject *)replace((PyBytesObject *) self,
2163 from_s, from_len,
2164 to_s, to_len, count);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002165}
2166
2167/** End DALKE **/
2168
2169/* Matches the end (direction >= 0) or start (direction < 0) of self
2170 * against substr, using the start and end arguments. Returns
2171 * -1 on error, 0 if not found and 1 if found.
2172 */
2173Py_LOCAL(int)
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002174_bytes_tailmatch(PyBytesObject *self, PyObject *substr, Py_ssize_t start,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002175 Py_ssize_t end, int direction)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002176{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002177 Py_ssize_t len = PyBytes_GET_SIZE(self);
2178 Py_ssize_t slen;
2179 const char* sub;
2180 const char* str;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002181
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002182 if (PyBytes_Check(substr)) {
2183 sub = PyBytes_AS_STRING(substr);
2184 slen = PyBytes_GET_SIZE(substr);
2185 }
2186 else if (PyObject_AsCharBuffer(substr, &sub, &slen))
2187 return -1;
2188 str = PyBytes_AS_STRING(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002189
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002190 ADJUST_INDICES(start, end, len);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002191
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002192 if (direction < 0) {
2193 /* startswith */
2194 if (start+slen > len)
2195 return 0;
2196 } else {
2197 /* endswith */
2198 if (end-start < slen || start > len)
2199 return 0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002201 if (end-slen > start)
2202 start = end - slen;
2203 }
2204 if (end-start >= slen)
2205 return ! memcmp(str+start, sub, slen);
2206 return 0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002207}
2208
2209
2210PyDoc_STRVAR(startswith__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00002211"B.startswith(prefix[, start[, end]]) -> bool\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002212\n\
2213Return True if B starts with the specified prefix, False otherwise.\n\
2214With optional start, test B beginning at that position.\n\
2215With optional end, stop comparing B at that position.\n\
Benjamin Peterson4116f362008-05-27 00:36:20 +00002216prefix can also be a tuple of bytes to try.");
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002217
2218static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002219bytes_startswith(PyBytesObject *self, PyObject *args)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002220{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002221 Py_ssize_t start = 0;
2222 Py_ssize_t end = PY_SSIZE_T_MAX;
2223 PyObject *subobj;
2224 int result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002225
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002226 if (!PyArg_ParseTuple(args, "O|O&O&:startswith", &subobj,
2227 _PyEval_SliceIndex, &start, _PyEval_SliceIndex, &end))
2228 return NULL;
2229 if (PyTuple_Check(subobj)) {
2230 Py_ssize_t i;
2231 for (i = 0; i < PyTuple_GET_SIZE(subobj); i++) {
2232 result = _bytes_tailmatch(self,
2233 PyTuple_GET_ITEM(subobj, i),
2234 start, end, -1);
2235 if (result == -1)
2236 return NULL;
2237 else if (result) {
2238 Py_RETURN_TRUE;
2239 }
2240 }
2241 Py_RETURN_FALSE;
2242 }
2243 result = _bytes_tailmatch(self, subobj, start, end, -1);
2244 if (result == -1)
2245 return NULL;
2246 else
2247 return PyBool_FromLong(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002248}
2249
2250
2251PyDoc_STRVAR(endswith__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00002252"B.endswith(suffix[, start[, end]]) -> bool\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002253\n\
2254Return True if B ends with the specified suffix, False otherwise.\n\
2255With optional start, test B beginning at that position.\n\
2256With optional end, stop comparing B at that position.\n\
Benjamin Peterson4116f362008-05-27 00:36:20 +00002257suffix can also be a tuple of bytes to try.");
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002258
2259static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002260bytes_endswith(PyBytesObject *self, PyObject *args)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002261{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002262 Py_ssize_t start = 0;
2263 Py_ssize_t end = PY_SSIZE_T_MAX;
2264 PyObject *subobj;
2265 int result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002267 if (!PyArg_ParseTuple(args, "O|O&O&:endswith", &subobj,
2268 _PyEval_SliceIndex, &start, _PyEval_SliceIndex, &end))
2269 return NULL;
2270 if (PyTuple_Check(subobj)) {
2271 Py_ssize_t i;
2272 for (i = 0; i < PyTuple_GET_SIZE(subobj); i++) {
2273 result = _bytes_tailmatch(self,
2274 PyTuple_GET_ITEM(subobj, i),
2275 start, end, +1);
2276 if (result == -1)
2277 return NULL;
2278 else if (result) {
2279 Py_RETURN_TRUE;
2280 }
2281 }
2282 Py_RETURN_FALSE;
2283 }
2284 result = _bytes_tailmatch(self, subobj, start, end, +1);
2285 if (result == -1)
2286 return NULL;
2287 else
2288 return PyBool_FromLong(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002289}
2290
2291
2292PyDoc_STRVAR(decode__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00002293"B.decode([encoding[, errors]]) -> str\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002294\n\
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002295Decode B using the codec registered for encoding. encoding defaults\n\
Guido van Rossumd624f182006-04-24 13:47:05 +00002296to the default encoding. errors may be given to set a different error\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00002297handling scheme. Default is 'strict' meaning that encoding errors raise\n\
2298a UnicodeDecodeError. Other possible values are 'ignore' and 'replace'\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002299as well as any other name registerd with codecs.register_error that is\n\
Guido van Rossumd624f182006-04-24 13:47:05 +00002300able to handle UnicodeDecodeErrors.");
2301
2302static PyObject *
Benjamin Peterson308d6372009-09-18 21:42:35 +00002303bytes_decode(PyObject *self, PyObject *args, PyObject *kwargs)
Guido van Rossumb6f1fdc2007-04-12 22:49:52 +00002304{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002305 const char *encoding = NULL;
2306 const char *errors = NULL;
2307 static char *kwlist[] = {"encoding", "errors", 0};
Guido van Rossumd624f182006-04-24 13:47:05 +00002308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002309 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|ss:decode", kwlist, &encoding, &errors))
2310 return NULL;
2311 if (encoding == NULL)
2312 encoding = PyUnicode_GetDefaultEncoding();
2313 return PyUnicode_FromEncodedObject(self, encoding, errors);
Guido van Rossumd624f182006-04-24 13:47:05 +00002314}
2315
Guido van Rossum20188312006-05-05 15:15:40 +00002316
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002317PyDoc_STRVAR(splitlines__doc__,
2318"B.splitlines([keepends]) -> list of lines\n\
2319\n\
2320Return a list of the lines in B, breaking at line boundaries.\n\
2321Line breaks are not included in the resulting list unless keepends\n\
2322is given and true.");
2323
2324static PyObject*
2325bytes_splitlines(PyObject *self, PyObject *args)
2326{
2327 int keepends = 0;
2328
2329 if (!PyArg_ParseTuple(args, "|i:splitlines", &keepends))
Antoine Pitroud1188562010-06-09 16:38:55 +00002330 return NULL;
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002331
2332 return stringlib_splitlines(
Antoine Pitroud1188562010-06-09 16:38:55 +00002333 (PyObject*) self, PyBytes_AS_STRING(self),
2334 PyBytes_GET_SIZE(self), keepends
2335 );
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002336}
2337
2338
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002339PyDoc_STRVAR(fromhex_doc,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002340"bytes.fromhex(string) -> bytes\n\
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002341\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002342Create a bytes object from a string of hexadecimal numbers.\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00002343Spaces between two numbers are accepted.\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002344Example: bytes.fromhex('B9 01EF') -> b'\\xb9\\x01\\xef'.");
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002345
2346static int
Guido van Rossumae404e22007-10-26 21:46:44 +00002347hex_digit_to_int(Py_UNICODE c)
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002348{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002349 if (c >= 128)
2350 return -1;
2351 if (ISDIGIT(c))
2352 return c - '0';
2353 else {
2354 if (ISUPPER(c))
2355 c = TOLOWER(c);
2356 if (c >= 'a' && c <= 'f')
2357 return c - 'a' + 10;
2358 }
2359 return -1;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002360}
2361
2362static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002363bytes_fromhex(PyObject *cls, PyObject *args)
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002364{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002365 PyObject *newstring, *hexobj;
2366 char *buf;
2367 Py_UNICODE *hex;
2368 Py_ssize_t hexlen, byteslen, i, j;
2369 int top, bot;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002371 if (!PyArg_ParseTuple(args, "U:fromhex", &hexobj))
2372 return NULL;
2373 assert(PyUnicode_Check(hexobj));
2374 hexlen = PyUnicode_GET_SIZE(hexobj);
2375 hex = PyUnicode_AS_UNICODE(hexobj);
2376 byteslen = hexlen/2; /* This overestimates if there are spaces */
2377 newstring = PyBytes_FromStringAndSize(NULL, byteslen);
2378 if (!newstring)
2379 return NULL;
2380 buf = PyBytes_AS_STRING(newstring);
2381 for (i = j = 0; i < hexlen; i += 2) {
2382 /* skip over spaces in the input */
2383 while (hex[i] == ' ')
2384 i++;
2385 if (i >= hexlen)
2386 break;
2387 top = hex_digit_to_int(hex[i]);
2388 bot = hex_digit_to_int(hex[i+1]);
2389 if (top == -1 || bot == -1) {
2390 PyErr_Format(PyExc_ValueError,
2391 "non-hexadecimal number found in "
2392 "fromhex() arg at position %zd", i);
2393 goto error;
2394 }
2395 buf[j++] = (top << 4) + bot;
2396 }
2397 if (j != byteslen && _PyBytes_Resize(&newstring, j) < 0)
2398 goto error;
2399 return newstring;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002400
2401 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002402 Py_XDECREF(newstring);
2403 return NULL;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002404}
2405
Martin v. Löwis00709aa2008-06-04 14:18:43 +00002406PyDoc_STRVAR(sizeof__doc__,
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002407"B.__sizeof__() -> size of B in memory, in bytes");
Martin v. Löwis00709aa2008-06-04 14:18:43 +00002408
2409static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002410bytes_sizeof(PyBytesObject *v)
Martin v. Löwis00709aa2008-06-04 14:18:43 +00002411{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002412 Py_ssize_t res;
2413 res = PyBytesObject_SIZE + Py_SIZE(v) * Py_TYPE(v)->tp_itemsize;
2414 return PyLong_FromSsize_t(res);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00002415}
2416
Guido van Rossum0dd32e22007-04-11 05:40:58 +00002417
2418static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002419bytes_getnewargs(PyBytesObject *v)
Guido van Rossum0dd32e22007-04-11 05:40:58 +00002420{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002421 return Py_BuildValue("(y#)", v->ob_sval, Py_SIZE(v));
Guido van Rossum0dd32e22007-04-11 05:40:58 +00002422}
2423
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002424
2425static PyMethodDef
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002426bytes_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002427 {"__getnewargs__", (PyCFunction)bytes_getnewargs, METH_NOARGS},
2428 {"capitalize", (PyCFunction)stringlib_capitalize, METH_NOARGS,
2429 _Py_capitalize__doc__},
2430 {"center", (PyCFunction)stringlib_center, METH_VARARGS, center__doc__},
2431 {"count", (PyCFunction)bytes_count, METH_VARARGS, count__doc__},
2432 {"decode", (PyCFunction)bytes_decode, METH_VARARGS | METH_KEYWORDS, decode__doc__},
2433 {"endswith", (PyCFunction)bytes_endswith, METH_VARARGS,
2434 endswith__doc__},
2435 {"expandtabs", (PyCFunction)stringlib_expandtabs, METH_VARARGS,
2436 expandtabs__doc__},
2437 {"find", (PyCFunction)bytes_find, METH_VARARGS, find__doc__},
2438 {"fromhex", (PyCFunction)bytes_fromhex, METH_VARARGS|METH_CLASS,
2439 fromhex_doc},
2440 {"index", (PyCFunction)bytes_index, METH_VARARGS, index__doc__},
2441 {"isalnum", (PyCFunction)stringlib_isalnum, METH_NOARGS,
2442 _Py_isalnum__doc__},
2443 {"isalpha", (PyCFunction)stringlib_isalpha, METH_NOARGS,
2444 _Py_isalpha__doc__},
2445 {"isdigit", (PyCFunction)stringlib_isdigit, METH_NOARGS,
2446 _Py_isdigit__doc__},
2447 {"islower", (PyCFunction)stringlib_islower, METH_NOARGS,
2448 _Py_islower__doc__},
2449 {"isspace", (PyCFunction)stringlib_isspace, METH_NOARGS,
2450 _Py_isspace__doc__},
2451 {"istitle", (PyCFunction)stringlib_istitle, METH_NOARGS,
2452 _Py_istitle__doc__},
2453 {"isupper", (PyCFunction)stringlib_isupper, METH_NOARGS,
2454 _Py_isupper__doc__},
2455 {"join", (PyCFunction)bytes_join, METH_O, join__doc__},
2456 {"ljust", (PyCFunction)stringlib_ljust, METH_VARARGS, ljust__doc__},
2457 {"lower", (PyCFunction)stringlib_lower, METH_NOARGS, _Py_lower__doc__},
2458 {"lstrip", (PyCFunction)bytes_lstrip, METH_VARARGS, lstrip__doc__},
2459 {"maketrans", (PyCFunction)bytes_maketrans, METH_VARARGS|METH_STATIC,
2460 _Py_maketrans__doc__},
2461 {"partition", (PyCFunction)bytes_partition, METH_O, partition__doc__},
2462 {"replace", (PyCFunction)bytes_replace, METH_VARARGS, replace__doc__},
2463 {"rfind", (PyCFunction)bytes_rfind, METH_VARARGS, rfind__doc__},
2464 {"rindex", (PyCFunction)bytes_rindex, METH_VARARGS, rindex__doc__},
2465 {"rjust", (PyCFunction)stringlib_rjust, METH_VARARGS, rjust__doc__},
2466 {"rpartition", (PyCFunction)bytes_rpartition, METH_O,
2467 rpartition__doc__},
2468 {"rsplit", (PyCFunction)bytes_rsplit, METH_VARARGS, rsplit__doc__},
2469 {"rstrip", (PyCFunction)bytes_rstrip, METH_VARARGS, rstrip__doc__},
2470 {"split", (PyCFunction)bytes_split, METH_VARARGS, split__doc__},
2471 {"splitlines", (PyCFunction)bytes_splitlines, METH_VARARGS,
2472 splitlines__doc__},
2473 {"startswith", (PyCFunction)bytes_startswith, METH_VARARGS,
2474 startswith__doc__},
2475 {"strip", (PyCFunction)bytes_strip, METH_VARARGS, strip__doc__},
2476 {"swapcase", (PyCFunction)stringlib_swapcase, METH_NOARGS,
2477 _Py_swapcase__doc__},
2478 {"title", (PyCFunction)stringlib_title, METH_NOARGS, _Py_title__doc__},
2479 {"translate", (PyCFunction)bytes_translate, METH_VARARGS,
2480 translate__doc__},
2481 {"upper", (PyCFunction)stringlib_upper, METH_NOARGS, _Py_upper__doc__},
2482 {"zfill", (PyCFunction)stringlib_zfill, METH_VARARGS, zfill__doc__},
2483 {"__sizeof__", (PyCFunction)bytes_sizeof, METH_NOARGS,
2484 sizeof__doc__},
2485 {NULL, NULL} /* sentinel */
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002486};
2487
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002488static PyObject *
2489str_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
2490
2491static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002492bytes_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002493{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002494 PyObject *x = NULL;
2495 const char *encoding = NULL;
2496 const char *errors = NULL;
2497 PyObject *new = NULL;
2498 Py_ssize_t size;
2499 static char *kwlist[] = {"source", "encoding", "errors", 0};
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002500
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002501 if (type != &PyBytes_Type)
2502 return str_subtype_new(type, args, kwds);
2503 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oss:bytes", kwlist, &x,
2504 &encoding, &errors))
2505 return NULL;
2506 if (x == NULL) {
2507 if (encoding != NULL || errors != NULL) {
2508 PyErr_SetString(PyExc_TypeError,
2509 "encoding or errors without sequence "
2510 "argument");
2511 return NULL;
2512 }
2513 return PyBytes_FromString("");
2514 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 if (PyUnicode_Check(x)) {
2517 /* Encode via the codec registry */
2518 if (encoding == NULL) {
2519 PyErr_SetString(PyExc_TypeError,
2520 "string argument without an encoding");
2521 return NULL;
2522 }
2523 new = PyUnicode_AsEncodedString(x, encoding, errors);
2524 if (new == NULL)
2525 return NULL;
2526 assert(PyBytes_Check(new));
2527 return new;
2528 }
2529 /* Is it an integer? */
2530 size = PyNumber_AsSsize_t(x, PyExc_OverflowError);
2531 if (size == -1 && PyErr_Occurred()) {
2532 if (PyErr_ExceptionMatches(PyExc_OverflowError))
2533 return NULL;
2534 PyErr_Clear();
2535 }
2536 else if (size < 0) {
2537 PyErr_SetString(PyExc_ValueError, "negative count");
2538 return NULL;
2539 }
2540 else {
2541 new = PyBytes_FromStringAndSize(NULL, size);
2542 if (new == NULL) {
2543 return NULL;
2544 }
2545 if (size > 0) {
2546 memset(((PyBytesObject*)new)->ob_sval, 0, size);
2547 }
2548 return new;
2549 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002550
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002551 /* If it's not unicode, there can't be encoding or errors */
2552 if (encoding != NULL || errors != NULL) {
2553 PyErr_SetString(PyExc_TypeError,
2554 "encoding or errors without a string argument");
2555 return NULL;
2556 }
2557 return PyObject_Bytes(x);
Benjamin Petersonc15a0732008-08-26 16:46:47 +00002558}
2559
2560PyObject *
2561PyBytes_FromObject(PyObject *x)
2562{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002563 PyObject *new, *it;
2564 Py_ssize_t i, size;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002566 if (x == NULL) {
2567 PyErr_BadInternalCall();
2568 return NULL;
2569 }
2570 /* Use the modern buffer interface */
2571 if (PyObject_CheckBuffer(x)) {
2572 Py_buffer view;
2573 if (PyObject_GetBuffer(x, &view, PyBUF_FULL_RO) < 0)
2574 return NULL;
2575 new = PyBytes_FromStringAndSize(NULL, view.len);
2576 if (!new)
2577 goto fail;
2578 /* XXX(brett.cannon): Better way to get to internal buffer? */
2579 if (PyBuffer_ToContiguous(((PyBytesObject *)new)->ob_sval,
2580 &view, view.len, 'C') < 0)
2581 goto fail;
2582 PyBuffer_Release(&view);
2583 return new;
2584 fail:
2585 Py_XDECREF(new);
2586 PyBuffer_Release(&view);
2587 return NULL;
2588 }
2589 if (PyUnicode_Check(x)) {
2590 PyErr_SetString(PyExc_TypeError,
2591 "cannot convert unicode object to bytes");
2592 return NULL;
2593 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002594
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002595 if (PyList_CheckExact(x)) {
2596 new = PyBytes_FromStringAndSize(NULL, Py_SIZE(x));
2597 if (new == NULL)
2598 return NULL;
2599 for (i = 0; i < Py_SIZE(x); i++) {
2600 Py_ssize_t value = PyNumber_AsSsize_t(
2601 PyList_GET_ITEM(x, i), PyExc_ValueError);
2602 if (value == -1 && PyErr_Occurred()) {
2603 Py_DECREF(new);
2604 return NULL;
2605 }
2606 if (value < 0 || value >= 256) {
2607 PyErr_SetString(PyExc_ValueError,
2608 "bytes must be in range(0, 256)");
2609 Py_DECREF(new);
2610 return NULL;
2611 }
Antoine Pitrou0010d372010-08-15 17:12:55 +00002612 ((PyBytesObject *)new)->ob_sval[i] = (char) value;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002613 }
2614 return new;
2615 }
2616 if (PyTuple_CheckExact(x)) {
2617 new = PyBytes_FromStringAndSize(NULL, Py_SIZE(x));
2618 if (new == NULL)
2619 return NULL;
2620 for (i = 0; i < Py_SIZE(x); i++) {
2621 Py_ssize_t value = PyNumber_AsSsize_t(
2622 PyTuple_GET_ITEM(x, i), PyExc_ValueError);
2623 if (value == -1 && PyErr_Occurred()) {
2624 Py_DECREF(new);
2625 return NULL;
2626 }
2627 if (value < 0 || value >= 256) {
2628 PyErr_SetString(PyExc_ValueError,
2629 "bytes must be in range(0, 256)");
2630 Py_DECREF(new);
2631 return NULL;
2632 }
Antoine Pitrou0010d372010-08-15 17:12:55 +00002633 ((PyBytesObject *)new)->ob_sval[i] = (char) value;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002634 }
2635 return new;
2636 }
Alexandre Vassalottia5c565a2010-01-09 22:14:46 +00002637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002638 /* For iterator version, create a string object and resize as needed */
2639 size = _PyObject_LengthHint(x, 64);
2640 if (size == -1 && PyErr_Occurred())
2641 return NULL;
2642 /* Allocate an extra byte to prevent PyBytes_FromStringAndSize() from
2643 returning a shared empty bytes string. This required because we
2644 want to call _PyBytes_Resize() the returned object, which we can
2645 only do on bytes objects with refcount == 1. */
2646 size += 1;
2647 new = PyBytes_FromStringAndSize(NULL, size);
2648 if (new == NULL)
2649 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002650
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002651 /* Get the iterator */
2652 it = PyObject_GetIter(x);
2653 if (it == NULL)
2654 goto error;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002655
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002656 /* Run the iterator to exhaustion */
2657 for (i = 0; ; i++) {
2658 PyObject *item;
2659 Py_ssize_t value;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002661 /* Get the next item */
2662 item = PyIter_Next(it);
2663 if (item == NULL) {
2664 if (PyErr_Occurred())
2665 goto error;
2666 break;
2667 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002668
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002669 /* Interpret it as an int (__index__) */
2670 value = PyNumber_AsSsize_t(item, PyExc_ValueError);
2671 Py_DECREF(item);
2672 if (value == -1 && PyErr_Occurred())
2673 goto error;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002675 /* Range check */
2676 if (value < 0 || value >= 256) {
2677 PyErr_SetString(PyExc_ValueError,
2678 "bytes must be in range(0, 256)");
2679 goto error;
2680 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002682 /* Append the byte */
2683 if (i >= size) {
2684 size = 2 * size + 1;
2685 if (_PyBytes_Resize(&new, size) < 0)
2686 goto error;
2687 }
Antoine Pitrou0010d372010-08-15 17:12:55 +00002688 ((PyBytesObject *)new)->ob_sval[i] = (char) value;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002689 }
2690 _PyBytes_Resize(&new, i);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002691
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002692 /* Clean up and return success */
2693 Py_DECREF(it);
2694 return new;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002695
2696 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002697 /* Error handling when new != NULL */
2698 Py_XDECREF(it);
2699 Py_DECREF(new);
2700 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002701}
2702
2703static PyObject *
2704str_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2705{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002706 PyObject *tmp, *pnew;
2707 Py_ssize_t n;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002708
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002709 assert(PyType_IsSubtype(type, &PyBytes_Type));
2710 tmp = bytes_new(&PyBytes_Type, args, kwds);
2711 if (tmp == NULL)
2712 return NULL;
2713 assert(PyBytes_CheckExact(tmp));
2714 n = PyBytes_GET_SIZE(tmp);
2715 pnew = type->tp_alloc(type, n);
2716 if (pnew != NULL) {
2717 Py_MEMCPY(PyBytes_AS_STRING(pnew),
2718 PyBytes_AS_STRING(tmp), n+1);
2719 ((PyBytesObject *)pnew)->ob_shash =
2720 ((PyBytesObject *)tmp)->ob_shash;
2721 }
2722 Py_DECREF(tmp);
2723 return pnew;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002724}
2725
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002726PyDoc_STRVAR(bytes_doc,
Georg Brandl17cb8a82008-05-30 08:20:09 +00002727"bytes(iterable_of_ints) -> bytes\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002728bytes(string, encoding[, errors]) -> bytes\n\
Georg Brandl17cb8a82008-05-30 08:20:09 +00002729bytes(bytes_or_buffer) -> immutable copy of bytes_or_buffer\n\
2730bytes(memory_view) -> bytes\n\
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002731\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002732Construct an immutable array of bytes from:\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00002733 - an iterable yielding integers in range(256)\n\
2734 - a text string encoded using the specified encoding\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002735 - a bytes or a buffer object\n\
2736 - any object implementing the buffer API.");
Guido van Rossum98297ee2007-11-06 21:34:58 +00002737
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002738static PyObject *bytes_iter(PyObject *seq);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002739
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002740PyTypeObject PyBytes_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002741 PyVarObject_HEAD_INIT(&PyType_Type, 0)
2742 "bytes",
2743 PyBytesObject_SIZE,
2744 sizeof(char),
2745 bytes_dealloc, /* tp_dealloc */
2746 0, /* tp_print */
2747 0, /* tp_getattr */
2748 0, /* tp_setattr */
2749 0, /* tp_reserved */
2750 (reprfunc)bytes_repr, /* tp_repr */
2751 0, /* tp_as_number */
2752 &bytes_as_sequence, /* tp_as_sequence */
2753 &bytes_as_mapping, /* tp_as_mapping */
2754 (hashfunc)bytes_hash, /* tp_hash */
2755 0, /* tp_call */
2756 bytes_str, /* tp_str */
2757 PyObject_GenericGetAttr, /* tp_getattro */
2758 0, /* tp_setattro */
2759 &bytes_as_buffer, /* tp_as_buffer */
2760 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
2761 Py_TPFLAGS_BYTES_SUBCLASS, /* tp_flags */
2762 bytes_doc, /* tp_doc */
2763 0, /* tp_traverse */
2764 0, /* tp_clear */
2765 (richcmpfunc)bytes_richcompare, /* tp_richcompare */
2766 0, /* tp_weaklistoffset */
2767 bytes_iter, /* tp_iter */
2768 0, /* tp_iternext */
2769 bytes_methods, /* tp_methods */
2770 0, /* tp_members */
2771 0, /* tp_getset */
2772 &PyBaseObject_Type, /* tp_base */
2773 0, /* tp_dict */
2774 0, /* tp_descr_get */
2775 0, /* tp_descr_set */
2776 0, /* tp_dictoffset */
2777 0, /* tp_init */
2778 0, /* tp_alloc */
2779 bytes_new, /* tp_new */
2780 PyObject_Del, /* tp_free */
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002781};
Guido van Rossuma5d2d552007-10-26 17:39:48 +00002782
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002783void
2784PyBytes_Concat(register PyObject **pv, register PyObject *w)
2785{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002786 register PyObject *v;
2787 assert(pv != NULL);
2788 if (*pv == NULL)
2789 return;
2790 if (w == NULL) {
2791 Py_DECREF(*pv);
2792 *pv = NULL;
2793 return;
2794 }
2795 v = bytes_concat(*pv, w);
2796 Py_DECREF(*pv);
2797 *pv = v;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002798}
2799
2800void
2801PyBytes_ConcatAndDel(register PyObject **pv, register PyObject *w)
2802{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002803 PyBytes_Concat(pv, w);
2804 Py_XDECREF(w);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002805}
2806
2807
2808/* The following function breaks the notion that strings are immutable:
2809 it changes the size of a string. We get away with this only if there
2810 is only one module referencing the object. You can also think of it
2811 as creating a new string object and destroying the old one, only
2812 more efficiently. In any case, don't use this if the string may
2813 already be known to some other part of the code...
2814 Note that if there's not enough memory to resize the string, the original
2815 string object at *pv is deallocated, *pv is set to NULL, an "out of
2816 memory" exception is set, and -1 is returned. Else (on success) 0 is
2817 returned, and the value in *pv may or may not be the same as on input.
2818 As always, an extra byte is allocated for a trailing \0 byte (newsize
2819 does *not* include that), and a trailing \0 byte is stored.
2820*/
2821
2822int
2823_PyBytes_Resize(PyObject **pv, Py_ssize_t newsize)
2824{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002825 register PyObject *v;
2826 register PyBytesObject *sv;
2827 v = *pv;
2828 if (!PyBytes_Check(v) || Py_REFCNT(v) != 1 || newsize < 0) {
2829 *pv = 0;
2830 Py_DECREF(v);
2831 PyErr_BadInternalCall();
2832 return -1;
2833 }
2834 /* XXX UNREF/NEWREF interface should be more symmetrical */
2835 _Py_DEC_REFTOTAL;
2836 _Py_ForgetReference(v);
2837 *pv = (PyObject *)
2838 PyObject_REALLOC((char *)v, PyBytesObject_SIZE + newsize);
2839 if (*pv == NULL) {
2840 PyObject_Del(v);
2841 PyErr_NoMemory();
2842 return -1;
2843 }
2844 _Py_NewReference(*pv);
2845 sv = (PyBytesObject *) *pv;
2846 Py_SIZE(sv) = newsize;
2847 sv->ob_sval[newsize] = '\0';
2848 sv->ob_shash = -1; /* invalidate cached hash value */
2849 return 0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002850}
2851
2852/* _PyBytes_FormatLong emulates the format codes d, u, o, x and X, and
2853 * the F_ALT flag, for Python's long (unbounded) ints. It's not used for
2854 * Python's regular ints.
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002855 * Return value: a new PyBytes*, or NULL if error.
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002856 * . *pbuf is set to point into it,
2857 * *plen set to the # of chars following that.
2858 * Caller must decref it when done using pbuf.
2859 * The string starting at *pbuf is of the form
2860 * "-"? ("0x" | "0X")? digit+
2861 * "0x"/"0X" are present only for x and X conversions, with F_ALT
2862 * set in flags. The case of hex digits will be correct,
2863 * There will be at least prec digits, zero-filled on the left if
2864 * necessary to get that many.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002865 * val object to be converted
2866 * flags bitmask of format flags; only F_ALT is looked at
2867 * prec minimum number of digits; 0-fill on left if needed
2868 * type a character in [duoxX]; u acts the same as d
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002869 *
2870 * CAUTION: o, x and X conversions on regular ints can never
2871 * produce a '-' sign, but can for Python's unbounded ints.
2872 */
2873PyObject*
2874_PyBytes_FormatLong(PyObject *val, int flags, int prec, int type,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002875 char **pbuf, int *plen)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002876{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002877 PyObject *result = NULL;
2878 char *buf;
2879 Py_ssize_t i;
2880 int sign; /* 1 if '-', else 0 */
2881 int len; /* number of characters */
2882 Py_ssize_t llen;
2883 int numdigits; /* len == numnondigits + numdigits */
2884 int numnondigits = 0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002885
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002886 /* Avoid exceeding SSIZE_T_MAX */
2887 if (prec > INT_MAX-3) {
2888 PyErr_SetString(PyExc_OverflowError,
2889 "precision too large");
2890 return NULL;
2891 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002892
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002893 switch (type) {
2894 case 'd':
2895 case 'u':
2896 /* Special-case boolean: we want 0/1 */
2897 if (PyBool_Check(val))
2898 result = PyNumber_ToBase(val, 10);
2899 else
2900 result = Py_TYPE(val)->tp_str(val);
2901 break;
2902 case 'o':
2903 numnondigits = 2;
2904 result = PyNumber_ToBase(val, 8);
2905 break;
2906 case 'x':
2907 case 'X':
2908 numnondigits = 2;
2909 result = PyNumber_ToBase(val, 16);
2910 break;
2911 default:
2912 assert(!"'type' not in [duoxX]");
2913 }
2914 if (!result)
2915 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002916
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002917 buf = _PyUnicode_AsString(result);
2918 if (!buf) {
2919 Py_DECREF(result);
2920 return NULL;
2921 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002923 /* To modify the string in-place, there can only be one reference. */
2924 if (Py_REFCNT(result) != 1) {
2925 PyErr_BadInternalCall();
2926 return NULL;
2927 }
2928 llen = PyUnicode_GetSize(result);
2929 if (llen > INT_MAX) {
2930 PyErr_SetString(PyExc_ValueError,
2931 "string too large in _PyBytes_FormatLong");
2932 return NULL;
2933 }
2934 len = (int)llen;
2935 if (buf[len-1] == 'L') {
2936 --len;
2937 buf[len] = '\0';
2938 }
2939 sign = buf[0] == '-';
2940 numnondigits += sign;
2941 numdigits = len - numnondigits;
2942 assert(numdigits > 0);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002943
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002944 /* Get rid of base marker unless F_ALT */
2945 if (((flags & F_ALT) == 0 &&
2946 (type == 'o' || type == 'x' || type == 'X'))) {
2947 assert(buf[sign] == '0');
2948 assert(buf[sign+1] == 'x' || buf[sign+1] == 'X' ||
2949 buf[sign+1] == 'o');
2950 numnondigits -= 2;
2951 buf += 2;
2952 len -= 2;
2953 if (sign)
2954 buf[0] = '-';
2955 assert(len == numnondigits + numdigits);
2956 assert(numdigits > 0);
2957 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002959 /* Fill with leading zeroes to meet minimum width. */
2960 if (prec > numdigits) {
2961 PyObject *r1 = PyBytes_FromStringAndSize(NULL,
2962 numnondigits + prec);
2963 char *b1;
2964 if (!r1) {
2965 Py_DECREF(result);
2966 return NULL;
2967 }
2968 b1 = PyBytes_AS_STRING(r1);
2969 for (i = 0; i < numnondigits; ++i)
2970 *b1++ = *buf++;
2971 for (i = 0; i < prec - numdigits; i++)
2972 *b1++ = '0';
2973 for (i = 0; i < numdigits; i++)
2974 *b1++ = *buf++;
2975 *b1 = '\0';
2976 Py_DECREF(result);
2977 result = r1;
2978 buf = PyBytes_AS_STRING(result);
2979 len = numnondigits + prec;
2980 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002982 /* Fix up case for hex conversions. */
2983 if (type == 'X') {
2984 /* Need to convert all lower case letters to upper case.
2985 and need to convert 0x to 0X (and -0x to -0X). */
2986 for (i = 0; i < len; i++)
2987 if (buf[i] >= 'a' && buf[i] <= 'x')
2988 buf[i] -= 'a'-'A';
2989 }
2990 *pbuf = buf;
2991 *plen = len;
2992 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002993}
2994
2995void
2996PyBytes_Fini(void)
2997{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002998 int i;
2999 for (i = 0; i < UCHAR_MAX + 1; i++) {
3000 Py_XDECREF(characters[i]);
3001 characters[i] = NULL;
3002 }
3003 Py_XDECREF(nullstring);
3004 nullstring = NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003005}
3006
Benjamin Peterson4116f362008-05-27 00:36:20 +00003007/*********************** Bytes Iterator ****************************/
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003008
3009typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003010 PyObject_HEAD
3011 Py_ssize_t it_index;
3012 PyBytesObject *it_seq; /* Set to NULL when iterator is exhausted */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003013} striterobject;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003014
3015static void
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003016striter_dealloc(striterobject *it)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003017{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003018 _PyObject_GC_UNTRACK(it);
3019 Py_XDECREF(it->it_seq);
3020 PyObject_GC_Del(it);
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003021}
3022
3023static int
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003024striter_traverse(striterobject *it, visitproc visit, void *arg)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003025{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003026 Py_VISIT(it->it_seq);
3027 return 0;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003028}
3029
3030static PyObject *
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003031striter_next(striterobject *it)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003032{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003033 PyBytesObject *seq;
3034 PyObject *item;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003035
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003036 assert(it != NULL);
3037 seq = it->it_seq;
3038 if (seq == NULL)
3039 return NULL;
3040 assert(PyBytes_Check(seq));
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003041
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003042 if (it->it_index < PyBytes_GET_SIZE(seq)) {
3043 item = PyLong_FromLong(
3044 (unsigned char)seq->ob_sval[it->it_index]);
3045 if (item != NULL)
3046 ++it->it_index;
3047 return item;
3048 }
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003049
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003050 Py_DECREF(seq);
3051 it->it_seq = NULL;
3052 return NULL;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003053}
3054
3055static PyObject *
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003056striter_len(striterobject *it)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003057{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003058 Py_ssize_t len = 0;
3059 if (it->it_seq)
3060 len = PyBytes_GET_SIZE(it->it_seq) - it->it_index;
3061 return PyLong_FromSsize_t(len);
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003062}
3063
3064PyDoc_STRVAR(length_hint_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003065 "Private method returning an estimate of len(list(it)).");
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003066
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003067static PyMethodDef striter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003068 {"__length_hint__", (PyCFunction)striter_len, METH_NOARGS,
3069 length_hint_doc},
3070 {NULL, NULL} /* sentinel */
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003071};
3072
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003073PyTypeObject PyBytesIter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003074 PyVarObject_HEAD_INIT(&PyType_Type, 0)
3075 "bytes_iterator", /* tp_name */
3076 sizeof(striterobject), /* tp_basicsize */
3077 0, /* tp_itemsize */
3078 /* methods */
3079 (destructor)striter_dealloc, /* tp_dealloc */
3080 0, /* tp_print */
3081 0, /* tp_getattr */
3082 0, /* tp_setattr */
3083 0, /* tp_reserved */
3084 0, /* tp_repr */
3085 0, /* tp_as_number */
3086 0, /* tp_as_sequence */
3087 0, /* tp_as_mapping */
3088 0, /* tp_hash */
3089 0, /* tp_call */
3090 0, /* tp_str */
3091 PyObject_GenericGetAttr, /* tp_getattro */
3092 0, /* tp_setattro */
3093 0, /* tp_as_buffer */
3094 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
3095 0, /* tp_doc */
3096 (traverseproc)striter_traverse, /* tp_traverse */
3097 0, /* tp_clear */
3098 0, /* tp_richcompare */
3099 0, /* tp_weaklistoffset */
3100 PyObject_SelfIter, /* tp_iter */
3101 (iternextfunc)striter_next, /* tp_iternext */
3102 striter_methods, /* tp_methods */
3103 0,
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003104};
3105
3106static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00003107bytes_iter(PyObject *seq)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003108{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003109 striterobject *it;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003110
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003111 if (!PyBytes_Check(seq)) {
3112 PyErr_BadInternalCall();
3113 return NULL;
3114 }
3115 it = PyObject_GC_New(striterobject, &PyBytesIter_Type);
3116 if (it == NULL)
3117 return NULL;
3118 it->it_index = 0;
3119 Py_INCREF(seq);
3120 it->it_seq = (PyBytesObject *)seq;
3121 _PyObject_GC_TRACK(it);
3122 return (PyObject *)it;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003123}