blob: 0f7e7d3783d269d84a811f602544679a211c340a [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 Pitroua57aae72010-06-09 16:58:35 +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 Pitrou7f14f0d2010-05-09 16:14:21 +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
59 PyString object must be treated as immutable and you must not fill in nor
60 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 Pitrou7f14f0d2010-05-09 16:14:21 +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 Pitrou7f14f0d2010-05-09 16:14:21 +000080 null_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +000081#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +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 Pitrou7f14f0d2010-05-09 16:14:21 +000089 one_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +000090#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000091 Py_INCREF(op);
92 return (PyObject *)op;
93 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +000094
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +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 Pitrou7f14f0d2010-05-09 16:14:21 +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 Pitrou7f14f0d2010-05-09 16:14:21 +0000124 register size_t size;
125 register PyBytesObject *op;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000126
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +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 Pitrou7f14f0d2010-05-09 16:14:21 +0000136 null_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000137#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +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 Pitrou7f14f0d2010-05-09 16:14:21 +0000143 one_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000144#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000145 Py_INCREF(op);
146 return (PyObject *)op;
147 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000148
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +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 Pitrou7f14f0d2010-05-09 16:14:21 +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
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000176#ifdef VA_LIST_IS_ARRAY
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000177 Py_MEMCPY(count, vargs, sizeof(va_list));
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000178#else
179#ifdef __va_copy
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000180 __va_copy(count, vargs);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000181#else
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000182 count = vargs;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000183#endif
184#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000185 /* step 1: figure out how large a buffer we need */
186 for (f = format; *f; f++) {
187 if (*f == '%') {
188 const char* p = f;
189 while (*++f && *f != '%' && !ISALPHA(*f))
190 ;
Guido van Rossum343e97f2007-04-09 00:43:24 +0000191
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000192 /* skip the 'l' or 'z' in {%ld, %zd, %lu, %zu} since
193 * they don't affect the amount of space we reserve.
194 */
195 if ((*f == 'l' || *f == 'z') &&
196 (f[1] == 'd' || f[1] == 'u'))
197 ++f;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000198
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000199 switch (*f) {
200 case 'c':
201 (void)va_arg(count, int);
202 /* fall through... */
203 case '%':
204 n++;
205 break;
206 case 'd': case 'u': case 'i': case 'x':
207 (void) va_arg(count, int);
208 /* 20 bytes is enough to hold a 64-bit
209 integer. Decimal takes the most space.
210 This isn't enough for octal. */
211 n += 20;
212 break;
213 case 's':
214 s = va_arg(count, char*);
215 n += strlen(s);
216 break;
217 case 'p':
218 (void) va_arg(count, int);
219 /* maximum 64-bit pointer representation:
220 * 0xffffffffffffffff
221 * so 19 characters is enough.
222 * XXX I count 18 -- what's the extra for?
223 */
224 n += 19;
225 break;
226 default:
227 /* if we stumble upon an unknown
228 formatting code, copy the rest of
229 the format string to the output
230 string. (we cannot just skip the
231 code, since there's no way to know
232 what's in the argument list) */
233 n += strlen(p);
234 goto expand;
235 }
236 } else
237 n++;
238 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000239 expand:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000240 /* step 2: fill the buffer */
241 /* Since we've analyzed how much space we need for the worst case,
242 use sprintf directly instead of the slower PyOS_snprintf. */
243 string = PyBytes_FromStringAndSize(NULL, n);
244 if (!string)
245 return NULL;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000246
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000247 s = PyBytes_AsString(string);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000248
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000249 for (f = format; *f; f++) {
250 if (*f == '%') {
251 const char* p = f++;
252 Py_ssize_t i;
253 int longflag = 0;
254 int size_tflag = 0;
255 /* parse the width.precision part (we're only
256 interested in the precision value, if any) */
257 n = 0;
258 while (ISDIGIT(*f))
259 n = (n*10) + *f++ - '0';
260 if (*f == '.') {
261 f++;
262 n = 0;
263 while (ISDIGIT(*f))
264 n = (n*10) + *f++ - '0';
265 }
266 while (*f && *f != '%' && !ISALPHA(*f))
267 f++;
268 /* handle the long flag, but only for %ld and %lu.
269 others can be added when necessary. */
270 if (*f == 'l' && (f[1] == 'd' || f[1] == 'u')) {
271 longflag = 1;
272 ++f;
273 }
274 /* handle the size_t flag. */
275 if (*f == 'z' && (f[1] == 'd' || f[1] == 'u')) {
276 size_tflag = 1;
277 ++f;
278 }
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000279
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000280 switch (*f) {
281 case 'c':
282 *s++ = va_arg(vargs, int);
283 break;
284 case 'd':
285 if (longflag)
286 sprintf(s, "%ld", va_arg(vargs, long));
287 else if (size_tflag)
288 sprintf(s, "%" PY_FORMAT_SIZE_T "d",
289 va_arg(vargs, Py_ssize_t));
290 else
291 sprintf(s, "%d", va_arg(vargs, int));
292 s += strlen(s);
293 break;
294 case 'u':
295 if (longflag)
296 sprintf(s, "%lu",
297 va_arg(vargs, unsigned long));
298 else if (size_tflag)
299 sprintf(s, "%" PY_FORMAT_SIZE_T "u",
300 va_arg(vargs, size_t));
301 else
302 sprintf(s, "%u",
303 va_arg(vargs, unsigned int));
304 s += strlen(s);
305 break;
306 case 'i':
307 sprintf(s, "%i", va_arg(vargs, int));
308 s += strlen(s);
309 break;
310 case 'x':
311 sprintf(s, "%x", va_arg(vargs, int));
312 s += strlen(s);
313 break;
314 case 's':
315 p = va_arg(vargs, char*);
316 i = strlen(p);
317 if (n > 0 && i > n)
318 i = n;
319 Py_MEMCPY(s, p, i);
320 s += i;
321 break;
322 case 'p':
323 sprintf(s, "%p", va_arg(vargs, void*));
324 /* %p is ill-defined: ensure leading 0x. */
325 if (s[1] == 'X')
326 s[1] = 'x';
327 else if (s[1] != 'x') {
328 memmove(s+2, s, strlen(s)+1);
329 s[0] = '0';
330 s[1] = 'x';
331 }
332 s += strlen(s);
333 break;
334 case '%':
335 *s++ = '%';
336 break;
337 default:
338 strcpy(s, p);
339 s += strlen(s);
340 goto end;
341 }
342 } else
343 *s++ = *f;
344 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000345
346 end:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000347 _PyBytes_Resize(&string, s - PyBytes_AS_STRING(string));
348 return string;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000349}
350
351PyObject *
352PyBytes_FromFormat(const char *format, ...)
353{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000354 PyObject* ret;
355 va_list vargs;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000356
357#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000358 va_start(vargs, format);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000359#else
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000360 va_start(vargs);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000361#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000362 ret = PyBytes_FromFormatV(format, vargs);
363 va_end(vargs);
364 return ret;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000365}
366
367static void
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000368bytes_dealloc(PyObject *op)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000369{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000370 Py_TYPE(op)->tp_free(op);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000371}
372
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000373/* Unescape a backslash-escaped string. If unicode is non-zero,
374 the string is a u-literal. If recode_encoding is non-zero,
375 the string is UTF-8 encoded and should be re-encoded in the
376 specified encoding. */
377
378PyObject *PyBytes_DecodeEscape(const char *s,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000379 Py_ssize_t len,
380 const char *errors,
381 Py_ssize_t unicode,
382 const char *recode_encoding)
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000383{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000384 int c;
385 char *p, *buf;
386 const char *end;
387 PyObject *v;
388 Py_ssize_t newlen = recode_encoding ? 4*len:len;
389 v = PyBytes_FromStringAndSize((char *)NULL, newlen);
390 if (v == NULL)
391 return NULL;
392 p = buf = PyBytes_AsString(v);
393 end = s + len;
394 while (s < end) {
395 if (*s != '\\') {
396 non_esc:
397 if (recode_encoding && (*s & 0x80)) {
398 PyObject *u, *w;
399 char *r;
400 const char* t;
401 Py_ssize_t rn;
402 t = s;
403 /* Decode non-ASCII bytes as UTF-8. */
404 while (t < end && (*t & 0x80)) t++;
405 u = PyUnicode_DecodeUTF8(s, t - s, errors);
406 if(!u) goto failed;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000407
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000408 /* Recode them in target encoding. */
409 w = PyUnicode_AsEncodedString(
410 u, recode_encoding, errors);
411 Py_DECREF(u);
412 if (!w) goto failed;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000413
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000414 /* Append bytes to output buffer. */
415 assert(PyBytes_Check(w));
416 r = PyBytes_AS_STRING(w);
417 rn = PyBytes_GET_SIZE(w);
418 Py_MEMCPY(p, r, rn);
419 p += rn;
420 Py_DECREF(w);
421 s = t;
422 } else {
423 *p++ = *s++;
424 }
425 continue;
426 }
427 s++;
428 if (s==end) {
429 PyErr_SetString(PyExc_ValueError,
430 "Trailing \\ in string");
431 goto failed;
432 }
433 switch (*s++) {
434 /* XXX This assumes ASCII! */
435 case '\n': break;
436 case '\\': *p++ = '\\'; break;
437 case '\'': *p++ = '\''; break;
438 case '\"': *p++ = '\"'; break;
439 case 'b': *p++ = '\b'; break;
440 case 'f': *p++ = '\014'; break; /* FF */
441 case 't': *p++ = '\t'; break;
442 case 'n': *p++ = '\n'; break;
443 case 'r': *p++ = '\r'; break;
444 case 'v': *p++ = '\013'; break; /* VT */
445 case 'a': *p++ = '\007'; break; /* BEL, not classic C */
446 case '0': case '1': case '2': case '3':
447 case '4': case '5': case '6': case '7':
448 c = s[-1] - '0';
449 if (s < end && '0' <= *s && *s <= '7') {
450 c = (c<<3) + *s++ - '0';
451 if (s < end && '0' <= *s && *s <= '7')
452 c = (c<<3) + *s++ - '0';
453 }
454 *p++ = c;
455 break;
456 case 'x':
457 if (s+1 < end && ISXDIGIT(s[0]) && ISXDIGIT(s[1])) {
458 unsigned int x = 0;
459 c = Py_CHARMASK(*s);
460 s++;
461 if (ISDIGIT(c))
462 x = c - '0';
463 else if (ISLOWER(c))
464 x = 10 + c - 'a';
465 else
466 x = 10 + c - 'A';
467 x = x << 4;
468 c = Py_CHARMASK(*s);
469 s++;
470 if (ISDIGIT(c))
471 x += c - '0';
472 else if (ISLOWER(c))
473 x += 10 + c - 'a';
474 else
475 x += 10 + c - 'A';
476 *p++ = x;
477 break;
478 }
479 if (!errors || strcmp(errors, "strict") == 0) {
480 PyErr_SetString(PyExc_ValueError,
481 "invalid \\x escape");
482 goto failed;
483 }
484 if (strcmp(errors, "replace") == 0) {
485 *p++ = '?';
486 } else if (strcmp(errors, "ignore") == 0)
487 /* do nothing */;
488 else {
489 PyErr_Format(PyExc_ValueError,
490 "decoding error; unknown "
491 "error handling code: %.400s",
492 errors);
493 goto failed;
494 }
495 default:
496 *p++ = '\\';
497 s--;
498 goto non_esc; /* an arbitry number of unescaped
499 UTF-8 bytes may follow. */
500 }
501 }
502 if (p-buf < newlen)
503 _PyBytes_Resize(&v, p - buf);
504 return v;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000505 failed:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000506 Py_DECREF(v);
507 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000508}
509
510/* -------------------------------------------------------------------- */
511/* object api */
512
513Py_ssize_t
514PyBytes_Size(register PyObject *op)
515{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000516 if (!PyBytes_Check(op)) {
517 PyErr_Format(PyExc_TypeError,
518 "expected bytes, %.200s found", Py_TYPE(op)->tp_name);
519 return -1;
520 }
521 return Py_SIZE(op);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000522}
523
524char *
525PyBytes_AsString(register PyObject *op)
526{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000527 if (!PyBytes_Check(op)) {
528 PyErr_Format(PyExc_TypeError,
529 "expected bytes, %.200s found", Py_TYPE(op)->tp_name);
530 return NULL;
531 }
532 return ((PyBytesObject *)op)->ob_sval;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000533}
534
535int
536PyBytes_AsStringAndSize(register PyObject *obj,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000537 register char **s,
538 register Py_ssize_t *len)
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000539{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000540 if (s == NULL) {
541 PyErr_BadInternalCall();
542 return -1;
543 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000544
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000545 if (!PyBytes_Check(obj)) {
546 PyErr_Format(PyExc_TypeError,
547 "expected bytes, %.200s found", Py_TYPE(obj)->tp_name);
548 return -1;
549 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000550
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000551 *s = PyBytes_AS_STRING(obj);
552 if (len != NULL)
553 *len = PyBytes_GET_SIZE(obj);
554 else if (strlen(*s) != (size_t)PyBytes_GET_SIZE(obj)) {
555 PyErr_SetString(PyExc_TypeError,
556 "expected bytes with no null");
557 return -1;
558 }
559 return 0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000560}
Neal Norwitz6968b052007-02-27 19:02:19 +0000561
562/* -------------------------------------------------------------------- */
563/* Methods */
564
Eric Smith0923d1d2009-04-16 20:16:10 +0000565#include "stringlib/stringdefs.h"
Neal Norwitz6968b052007-02-27 19:02:19 +0000566#define STRINGLIB_CHAR char
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000567
Neal Norwitz6968b052007-02-27 19:02:19 +0000568#define STRINGLIB_CMP memcmp
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000569#define STRINGLIB_LEN PyBytes_GET_SIZE
570#define STRINGLIB_NEW PyBytes_FromStringAndSize
571#define STRINGLIB_STR PyBytes_AS_STRING
572/* #define STRINGLIB_WANT_CONTAINS_OBJ 1 */
573
574#define STRINGLIB_EMPTY nullstring
575#define STRINGLIB_CHECK_EXACT PyBytes_CheckExact
576#define STRINGLIB_MUTABLE 0
Neal Norwitz6968b052007-02-27 19:02:19 +0000577
578#include "stringlib/fastsearch.h"
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000579
Neal Norwitz6968b052007-02-27 19:02:19 +0000580#include "stringlib/count.h"
581#include "stringlib/find.h"
582#include "stringlib/partition.h"
Gregory P. Smith60d241f2007-10-16 06:31:30 +0000583#include "stringlib/ctype.h"
584#include "stringlib/transmogrify.h"
Neal Norwitz6968b052007-02-27 19:02:19 +0000585
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000586#define _Py_InsertThousandsGrouping _PyBytes_InsertThousandsGrouping
Eric Smitha3b1ac82009-04-03 14:45:06 +0000587#define _Py_InsertThousandsGroupingLocale _PyBytes_InsertThousandsGroupingLocale
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000588#include "stringlib/localeutil.h"
Neal Norwitz6968b052007-02-27 19:02:19 +0000589
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000590PyObject *
591PyBytes_Repr(PyObject *obj, int smartquotes)
Neal Norwitz6968b052007-02-27 19:02:19 +0000592{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000593 static const char *hexdigits = "0123456789abcdef";
594 register PyBytesObject* op = (PyBytesObject*) obj;
595 Py_ssize_t length = Py_SIZE(op);
596 size_t newsize = 3 + 4 * length;
597 PyObject *v;
598 if (newsize > PY_SSIZE_T_MAX || (newsize-3) / 4 != length) {
599 PyErr_SetString(PyExc_OverflowError,
600 "bytes object is too large to make repr");
601 return NULL;
602 }
603 v = PyUnicode_FromUnicode(NULL, newsize);
604 if (v == NULL) {
605 return NULL;
606 }
607 else {
608 register Py_ssize_t i;
609 register Py_UNICODE c;
610 register Py_UNICODE *p = PyUnicode_AS_UNICODE(v);
611 int quote;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000612
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000613 /* Figure out which quote to use; single is preferred */
614 quote = '\'';
615 if (smartquotes) {
616 char *test, *start;
617 start = PyBytes_AS_STRING(op);
618 for (test = start; test < start+length; ++test) {
619 if (*test == '"') {
620 quote = '\''; /* back to single */
621 goto decided;
622 }
623 else if (*test == '\'')
624 quote = '"';
625 }
626 decided:
627 ;
628 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000629
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000630 *p++ = 'b', *p++ = quote;
631 for (i = 0; i < length; i++) {
632 /* There's at least enough room for a hex escape
633 and a closing quote. */
634 assert(newsize - (p - PyUnicode_AS_UNICODE(v)) >= 5);
635 c = op->ob_sval[i];
636 if (c == quote || c == '\\')
637 *p++ = '\\', *p++ = c;
638 else if (c == '\t')
639 *p++ = '\\', *p++ = 't';
640 else if (c == '\n')
641 *p++ = '\\', *p++ = 'n';
642 else if (c == '\r')
643 *p++ = '\\', *p++ = 'r';
644 else if (c < ' ' || c >= 0x7f) {
645 *p++ = '\\';
646 *p++ = 'x';
647 *p++ = hexdigits[(c & 0xf0) >> 4];
648 *p++ = hexdigits[c & 0xf];
649 }
650 else
651 *p++ = c;
652 }
653 assert(newsize - (p - PyUnicode_AS_UNICODE(v)) >= 1);
654 *p++ = quote;
655 *p = '\0';
656 if (PyUnicode_Resize(&v, (p - PyUnicode_AS_UNICODE(v)))) {
657 Py_DECREF(v);
658 return NULL;
659 }
660 return v;
661 }
Neal Norwitz6968b052007-02-27 19:02:19 +0000662}
663
Neal Norwitz6968b052007-02-27 19:02:19 +0000664static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000665bytes_repr(PyObject *op)
Neal Norwitz6968b052007-02-27 19:02:19 +0000666{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000667 return PyBytes_Repr(op, 1);
Neal Norwitz6968b052007-02-27 19:02:19 +0000668}
669
Neal Norwitz6968b052007-02-27 19:02:19 +0000670static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000671bytes_str(PyObject *op)
Neal Norwitz6968b052007-02-27 19:02:19 +0000672{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000673 if (Py_BytesWarningFlag) {
674 if (PyErr_WarnEx(PyExc_BytesWarning,
675 "str() on a bytes instance", 1))
676 return NULL;
677 }
678 return bytes_repr(op);
Neal Norwitz6968b052007-02-27 19:02:19 +0000679}
680
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000681static Py_ssize_t
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000682bytes_length(PyBytesObject *a)
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000683{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000684 return Py_SIZE(a);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000685}
Neal Norwitz6968b052007-02-27 19:02:19 +0000686
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000687/* This is also used by PyBytes_Concat() */
688static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000689bytes_concat(PyObject *a, PyObject *b)
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000690{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000691 Py_ssize_t size;
692 Py_buffer va, vb;
693 PyObject *result = NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000694
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000695 va.len = -1;
696 vb.len = -1;
697 if (_getbuffer(a, &va) < 0 ||
698 _getbuffer(b, &vb) < 0) {
699 PyErr_Format(PyExc_TypeError, "can't concat %.100s to %.100s",
700 Py_TYPE(a)->tp_name, Py_TYPE(b)->tp_name);
701 goto done;
702 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000703
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000704 /* Optimize end cases */
705 if (va.len == 0 && PyBytes_CheckExact(b)) {
706 result = b;
707 Py_INCREF(result);
708 goto done;
709 }
710 if (vb.len == 0 && PyBytes_CheckExact(a)) {
711 result = a;
712 Py_INCREF(result);
713 goto done;
714 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000715
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000716 size = va.len + vb.len;
717 if (size < 0) {
718 PyErr_NoMemory();
719 goto done;
720 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000721
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000722 result = PyBytes_FromStringAndSize(NULL, size);
723 if (result != NULL) {
724 memcpy(PyBytes_AS_STRING(result), va.buf, va.len);
725 memcpy(PyBytes_AS_STRING(result) + va.len, vb.buf, vb.len);
726 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000727
728 done:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000729 if (va.len != -1)
730 PyBuffer_Release(&va);
731 if (vb.len != -1)
732 PyBuffer_Release(&vb);
733 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000734}
Neal Norwitz6968b052007-02-27 19:02:19 +0000735
736static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000737bytes_repeat(register PyBytesObject *a, register Py_ssize_t n)
Neal Norwitz6968b052007-02-27 19:02:19 +0000738{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000739 register Py_ssize_t i;
740 register Py_ssize_t j;
741 register Py_ssize_t size;
742 register PyBytesObject *op;
743 size_t nbytes;
744 if (n < 0)
745 n = 0;
746 /* watch out for overflows: the size can overflow int,
747 * and the # of bytes needed can overflow size_t
748 */
749 size = Py_SIZE(a) * n;
750 if (n && size / n != Py_SIZE(a)) {
751 PyErr_SetString(PyExc_OverflowError,
752 "repeated bytes are too long");
753 return NULL;
754 }
755 if (size == Py_SIZE(a) && PyBytes_CheckExact(a)) {
756 Py_INCREF(a);
757 return (PyObject *)a;
758 }
759 nbytes = (size_t)size;
760 if (nbytes + PyBytesObject_SIZE <= nbytes) {
761 PyErr_SetString(PyExc_OverflowError,
762 "repeated bytes are too long");
763 return NULL;
764 }
765 op = (PyBytesObject *)PyObject_MALLOC(PyBytesObject_SIZE + nbytes);
766 if (op == NULL)
767 return PyErr_NoMemory();
768 PyObject_INIT_VAR(op, &PyBytes_Type, size);
769 op->ob_shash = -1;
770 op->ob_sval[size] = '\0';
771 if (Py_SIZE(a) == 1 && n > 0) {
772 memset(op->ob_sval, a->ob_sval[0] , n);
773 return (PyObject *) op;
774 }
775 i = 0;
776 if (i < size) {
777 Py_MEMCPY(op->ob_sval, a->ob_sval, Py_SIZE(a));
778 i = Py_SIZE(a);
779 }
780 while (i < size) {
781 j = (i <= size-i) ? i : size-i;
782 Py_MEMCPY(op->ob_sval+i, op->ob_sval, j);
783 i += j;
784 }
785 return (PyObject *) op;
Neal Norwitz6968b052007-02-27 19:02:19 +0000786}
787
Guido van Rossum98297ee2007-11-06 21:34:58 +0000788static int
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000789bytes_contains(PyObject *self, PyObject *arg)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000790{
791 Py_ssize_t ival = PyNumber_AsSsize_t(arg, PyExc_ValueError);
792 if (ival == -1 && PyErr_Occurred()) {
Antoine Pitroua57aae72010-06-09 16:58:35 +0000793 Py_buffer varg;
794 int pos;
795 PyErr_Clear();
796 if (_getbuffer(arg, &varg) < 0)
797 return -1;
798 pos = stringlib_find(PyBytes_AS_STRING(self), Py_SIZE(self),
799 varg.buf, varg.len, 0);
800 PyBuffer_Release(&varg);
801 return pos >= 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000802 }
803 if (ival < 0 || ival >= 256) {
Antoine Pitroua57aae72010-06-09 16:58:35 +0000804 PyErr_SetString(PyExc_ValueError, "byte must be in range(0, 256)");
805 return -1;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000806 }
807
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000808 return memchr(PyBytes_AS_STRING(self), ival, Py_SIZE(self)) != NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000809}
810
Neal Norwitz6968b052007-02-27 19:02:19 +0000811static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000812bytes_item(PyBytesObject *a, register Py_ssize_t i)
Neal Norwitz6968b052007-02-27 19:02:19 +0000813{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000814 if (i < 0 || i >= Py_SIZE(a)) {
815 PyErr_SetString(PyExc_IndexError, "index out of range");
816 return NULL;
817 }
818 return PyLong_FromLong((unsigned char)a->ob_sval[i]);
Neal Norwitz6968b052007-02-27 19:02:19 +0000819}
820
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000821static PyObject*
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000822bytes_richcompare(PyBytesObject *a, PyBytesObject *b, int op)
Neal Norwitz6968b052007-02-27 19:02:19 +0000823{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000824 int c;
825 Py_ssize_t len_a, len_b;
826 Py_ssize_t min_len;
827 PyObject *result;
Neal Norwitz6968b052007-02-27 19:02:19 +0000828
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000829 /* Make sure both arguments are strings. */
830 if (!(PyBytes_Check(a) && PyBytes_Check(b))) {
831 if (Py_BytesWarningFlag && (op == Py_EQ || op == Py_NE) &&
832 (PyObject_IsInstance((PyObject*)a,
833 (PyObject*)&PyUnicode_Type) ||
834 PyObject_IsInstance((PyObject*)b,
835 (PyObject*)&PyUnicode_Type))) {
836 if (PyErr_WarnEx(PyExc_BytesWarning,
837 "Comparison between bytes and string", 1))
838 return NULL;
839 }
840 result = Py_NotImplemented;
841 goto out;
842 }
843 if (a == b) {
844 switch (op) {
845 case Py_EQ:case Py_LE:case Py_GE:
846 result = Py_True;
847 goto out;
848 case Py_NE:case Py_LT:case Py_GT:
849 result = Py_False;
850 goto out;
851 }
852 }
853 if (op == Py_EQ) {
854 /* Supporting Py_NE here as well does not save
855 much time, since Py_NE is rarely used. */
856 if (Py_SIZE(a) == Py_SIZE(b)
857 && (a->ob_sval[0] == b->ob_sval[0]
858 && memcmp(a->ob_sval, b->ob_sval, Py_SIZE(a)) == 0)) {
859 result = Py_True;
860 } else {
861 result = Py_False;
862 }
863 goto out;
864 }
865 len_a = Py_SIZE(a); len_b = Py_SIZE(b);
866 min_len = (len_a < len_b) ? len_a : len_b;
867 if (min_len > 0) {
868 c = Py_CHARMASK(*a->ob_sval) - Py_CHARMASK(*b->ob_sval);
869 if (c==0)
870 c = memcmp(a->ob_sval, b->ob_sval, min_len);
871 } else
872 c = 0;
873 if (c == 0)
874 c = (len_a < len_b) ? -1 : (len_a > len_b) ? 1 : 0;
875 switch (op) {
876 case Py_LT: c = c < 0; break;
877 case Py_LE: c = c <= 0; break;
878 case Py_EQ: assert(0); break; /* unreachable */
879 case Py_NE: c = c != 0; break;
880 case Py_GT: c = c > 0; break;
881 case Py_GE: c = c >= 0; break;
882 default:
883 result = Py_NotImplemented;
884 goto out;
885 }
886 result = c ? Py_True : Py_False;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000887 out:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000888 Py_INCREF(result);
889 return result;
Neal Norwitz6968b052007-02-27 19:02:19 +0000890}
891
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000892static long
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000893bytes_hash(PyBytesObject *a)
Neal Norwitz6968b052007-02-27 19:02:19 +0000894{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000895 register Py_ssize_t len;
896 register unsigned char *p;
897 register long x;
Neal Norwitz6968b052007-02-27 19:02:19 +0000898
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000899 if (a->ob_shash != -1)
900 return a->ob_shash;
901 len = Py_SIZE(a);
902 p = (unsigned char *) a->ob_sval;
903 x = *p << 7;
904 while (--len >= 0)
905 x = (1000003*x) ^ *p++;
906 x ^= Py_SIZE(a);
907 if (x == -1)
908 x = -2;
909 a->ob_shash = x;
910 return x;
Neal Norwitz6968b052007-02-27 19:02:19 +0000911}
912
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000913static PyObject*
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000914bytes_subscript(PyBytesObject* self, PyObject* item)
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000915{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000916 if (PyIndex_Check(item)) {
917 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
918 if (i == -1 && PyErr_Occurred())
919 return NULL;
920 if (i < 0)
921 i += PyBytes_GET_SIZE(self);
922 if (i < 0 || i >= PyBytes_GET_SIZE(self)) {
923 PyErr_SetString(PyExc_IndexError,
924 "index out of range");
925 return NULL;
926 }
927 return PyLong_FromLong((unsigned char)self->ob_sval[i]);
928 }
929 else if (PySlice_Check(item)) {
930 Py_ssize_t start, stop, step, slicelength, cur, i;
931 char* source_buf;
932 char* result_buf;
933 PyObject* result;
Neal Norwitz6968b052007-02-27 19:02:19 +0000934
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000935 if (PySlice_GetIndicesEx((PySliceObject*)item,
936 PyBytes_GET_SIZE(self),
937 &start, &stop, &step, &slicelength) < 0) {
938 return NULL;
939 }
Neal Norwitz6968b052007-02-27 19:02:19 +0000940
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000941 if (slicelength <= 0) {
942 return PyBytes_FromStringAndSize("", 0);
943 }
944 else if (start == 0 && step == 1 &&
945 slicelength == PyBytes_GET_SIZE(self) &&
946 PyBytes_CheckExact(self)) {
947 Py_INCREF(self);
948 return (PyObject *)self;
949 }
950 else if (step == 1) {
951 return PyBytes_FromStringAndSize(
952 PyBytes_AS_STRING(self) + start,
953 slicelength);
954 }
955 else {
956 source_buf = PyBytes_AS_STRING(self);
957 result = PyBytes_FromStringAndSize(NULL, slicelength);
958 if (result == NULL)
959 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +0000960
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000961 result_buf = PyBytes_AS_STRING(result);
962 for (cur = start, i = 0; i < slicelength;
963 cur += step, i++) {
964 result_buf[i] = source_buf[cur];
965 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000966
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000967 return result;
968 }
969 }
970 else {
971 PyErr_Format(PyExc_TypeError,
972 "byte indices must be integers, not %.200s",
973 Py_TYPE(item)->tp_name);
974 return NULL;
975 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000976}
977
978static int
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000979bytes_buffer_getbuffer(PyBytesObject *self, Py_buffer *view, int flags)
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000980{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000981 return PyBuffer_FillInfo(view, (PyObject*)self, (void *)self->ob_sval, Py_SIZE(self),
982 1, flags);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000983}
984
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000985static PySequenceMethods bytes_as_sequence = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000986 (lenfunc)bytes_length, /*sq_length*/
987 (binaryfunc)bytes_concat, /*sq_concat*/
988 (ssizeargfunc)bytes_repeat, /*sq_repeat*/
989 (ssizeargfunc)bytes_item, /*sq_item*/
990 0, /*sq_slice*/
991 0, /*sq_ass_item*/
992 0, /*sq_ass_slice*/
993 (objobjproc)bytes_contains /*sq_contains*/
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000994};
995
Benjamin Peterson80688ef2009-04-18 15:17:02 +0000996static PyMappingMethods bytes_as_mapping = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000997 (lenfunc)bytes_length,
998 (binaryfunc)bytes_subscript,
999 0,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001000};
1001
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001002static PyBufferProcs bytes_as_buffer = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001003 (getbufferproc)bytes_buffer_getbuffer,
1004 NULL,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001005};
1006
1007
1008#define LEFTSTRIP 0
1009#define RIGHTSTRIP 1
1010#define BOTHSTRIP 2
1011
1012/* Arrays indexed by above */
1013static const char *stripformat[] = {"|O:lstrip", "|O:rstrip", "|O:strip"};
1014
1015#define STRIPNAME(i) (stripformat[i]+3)
1016
Neal Norwitz6968b052007-02-27 19:02:19 +00001017
1018/* Don't call if length < 2 */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001019#define Py_STRING_MATCH(target, offset, pattern, length) \
1020 (target[offset] == pattern[0] && \
1021 target[offset+length-1] == pattern[length-1] && \
Neal Norwitz6968b052007-02-27 19:02:19 +00001022 !memcmp(target+offset+1, pattern+1, length-2) )
1023
1024
Neal Norwitz6968b052007-02-27 19:02:19 +00001025/* Overallocate the initial list to reduce the number of reallocs for small
1026 split sizes. Eg, "A A A A A A A A A A".split() (10 elements) has three
1027 resizes, to sizes 4, 8, then 16. Most observed string splits are for human
1028 text (roughly 11 words per line) and field delimited data (usually 1-10
1029 fields). For large strings the split algorithms are bandwidth limited
1030 so increasing the preallocation likely will not improve things.*/
1031
1032#define MAX_PREALLOC 12
1033
1034/* 5 splits gives 6 elements */
1035#define PREALLOC_SIZE(maxsplit) \
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001036 (maxsplit >= MAX_PREALLOC ? MAX_PREALLOC : maxsplit+1)
Neal Norwitz6968b052007-02-27 19:02:19 +00001037
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001038#define SPLIT_ADD(data, left, right) { \
1039 str = PyBytes_FromStringAndSize((data) + (left), \
1040 (right) - (left)); \
1041 if (str == NULL) \
1042 goto onError; \
1043 if (count < MAX_PREALLOC) { \
1044 PyList_SET_ITEM(list, count, str); \
1045 } else { \
1046 if (PyList_Append(list, str)) { \
1047 Py_DECREF(str); \
1048 goto onError; \
1049 } \
1050 else \
1051 Py_DECREF(str); \
1052 } \
1053 count++; }
Neal Norwitz6968b052007-02-27 19:02:19 +00001054
1055/* Always force the list to the expected size. */
Christian Heimes90aa7642007-12-19 02:45:37 +00001056#define FIX_PREALLOC_SIZE(list) Py_SIZE(list) = count
Neal Norwitz6968b052007-02-27 19:02:19 +00001057
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001058#define SKIP_SPACE(s, i, len) { while (i<len && ISSPACE(s[i])) i++; }
1059#define SKIP_NONSPACE(s, i, len) { while (i<len && !ISSPACE(s[i])) i++; }
1060#define RSKIP_SPACE(s, i) { while (i>=0 && ISSPACE(s[i])) i--; }
1061#define RSKIP_NONSPACE(s, i) { while (i>=0 && !ISSPACE(s[i])) i--; }
Neal Norwitz6968b052007-02-27 19:02:19 +00001062
1063Py_LOCAL_INLINE(PyObject *)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001064split_whitespace(PyBytesObject *self, Py_ssize_t len, Py_ssize_t maxsplit)
Neal Norwitz6968b052007-02-27 19:02:19 +00001065{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001066 const char *s = PyBytes_AS_STRING(self);
1067 Py_ssize_t i, j, count=0;
1068 PyObject *str;
1069 PyObject *list = PyList_New(PREALLOC_SIZE(maxsplit));
Neal Norwitz6968b052007-02-27 19:02:19 +00001070
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001071 if (list == NULL)
1072 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001073
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001074 i = j = 0;
Neal Norwitz6968b052007-02-27 19:02:19 +00001075
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001076 while (maxsplit-- > 0) {
1077 SKIP_SPACE(s, i, len);
1078 if (i==len) break;
1079 j = i; i++;
1080 SKIP_NONSPACE(s, i, len);
1081 if (j == 0 && i == len && PyBytes_CheckExact(self)) {
1082 /* No whitespace in self, so just use it as list[0] */
1083 Py_INCREF(self);
1084 PyList_SET_ITEM(list, 0, (PyObject *)self);
1085 count++;
1086 break;
1087 }
1088 SPLIT_ADD(s, j, i);
1089 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001090
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001091 if (i < len) {
1092 /* Only occurs when maxsplit was reached */
1093 /* Skip any remaining whitespace and copy to end of string */
1094 SKIP_SPACE(s, i, len);
1095 if (i != len)
1096 SPLIT_ADD(s, i, len);
1097 }
1098 FIX_PREALLOC_SIZE(list);
1099 return list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001100 onError:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001101 Py_DECREF(list);
1102 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001103}
1104
Guido van Rossum8f950672007-09-10 16:53:45 +00001105Py_LOCAL_INLINE(PyObject *)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001106split_char(PyBytesObject *self, Py_ssize_t len, char ch, Py_ssize_t maxcount)
Guido van Rossum8f950672007-09-10 16:53:45 +00001107{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001108 const char *s = PyBytes_AS_STRING(self);
1109 register Py_ssize_t i, j, count=0;
1110 PyObject *str;
1111 PyObject *list = PyList_New(PREALLOC_SIZE(maxcount));
Guido van Rossum8f950672007-09-10 16:53:45 +00001112
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001113 if (list == NULL)
1114 return NULL;
Guido van Rossum8f950672007-09-10 16:53:45 +00001115
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001116 i = j = 0;
1117 while ((j < len) && (maxcount-- > 0)) {
1118 for(; j<len; j++) {
1119 /* I found that using memchr makes no difference */
1120 if (s[j] == ch) {
1121 SPLIT_ADD(s, i, j);
1122 i = j = j + 1;
1123 break;
1124 }
1125 }
1126 }
1127 if (i == 0 && count == 0 && PyBytes_CheckExact(self)) {
1128 /* ch not in self, so just use self as list[0] */
1129 Py_INCREF(self);
1130 PyList_SET_ITEM(list, 0, (PyObject *)self);
1131 count++;
1132 }
1133 else if (i <= len) {
1134 SPLIT_ADD(s, i, len);
1135 }
1136 FIX_PREALLOC_SIZE(list);
1137 return list;
Guido van Rossum8f950672007-09-10 16:53:45 +00001138
1139 onError:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001140 Py_DECREF(list);
1141 return NULL;
Guido van Rossum8f950672007-09-10 16:53:45 +00001142}
1143
Neal Norwitz6968b052007-02-27 19:02:19 +00001144PyDoc_STRVAR(split__doc__,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001145"B.split([sep[, maxsplit]]) -> list of bytes\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001146\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00001147Return a list of the sections in B, using sep as the delimiter.\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001148If sep is not specified or is None, B is split on ASCII whitespace\n\
1149characters (space, tab, return, newline, formfeed, vertical tab).\n\
Guido van Rossum8f950672007-09-10 16:53:45 +00001150If maxsplit is given, at most maxsplit splits are done.");
Neal Norwitz6968b052007-02-27 19:02:19 +00001151
1152static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001153bytes_split(PyBytesObject *self, PyObject *args)
Neal Norwitz6968b052007-02-27 19:02:19 +00001154{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001155 Py_ssize_t len = PyBytes_GET_SIZE(self), n, i, j;
1156 Py_ssize_t maxsplit = -1, count=0;
1157 const char *s = PyBytes_AS_STRING(self), *sub;
1158 Py_buffer vsub;
1159 PyObject *list, *str, *subobj = Py_None;
Neal Norwitz6968b052007-02-27 19:02:19 +00001160#ifdef USE_FAST
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001161 Py_ssize_t pos;
Neal Norwitz6968b052007-02-27 19:02:19 +00001162#endif
1163
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001164 if (!PyArg_ParseTuple(args, "|On:split", &subobj, &maxsplit))
1165 return NULL;
1166 if (maxsplit < 0)
1167 maxsplit = PY_SSIZE_T_MAX;
1168 if (subobj == Py_None)
1169 return split_whitespace(self, len, maxsplit);
1170 if (_getbuffer(subobj, &vsub) < 0)
1171 return NULL;
1172 sub = vsub.buf;
1173 n = vsub.len;
Guido van Rossum8f950672007-09-10 16:53:45 +00001174
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001175 if (n == 0) {
1176 PyErr_SetString(PyExc_ValueError, "empty separator");
1177 PyBuffer_Release(&vsub);
1178 return NULL;
1179 }
1180 else if (n == 1) {
1181 list = split_char(self, len, sub[0], maxsplit);
1182 PyBuffer_Release(&vsub);
1183 return list;
1184 }
Guido van Rossum8f950672007-09-10 16:53:45 +00001185
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001186 list = PyList_New(PREALLOC_SIZE(maxsplit));
1187 if (list == NULL) {
1188 PyBuffer_Release(&vsub);
1189 return NULL;
1190 }
Neal Norwitz6968b052007-02-27 19:02:19 +00001191
1192#ifdef USE_FAST
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001193 i = j = 0;
1194 while (maxsplit-- > 0) {
1195 pos = fastsearch(s+i, len-i, sub, n, FAST_SEARCH);
1196 if (pos < 0)
1197 break;
1198 j = i+pos;
1199 SPLIT_ADD(s, i, j);
1200 i = j + n;
1201 }
Neal Norwitz6968b052007-02-27 19:02:19 +00001202#else
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001203 i = j = 0;
1204 while ((j+n <= len) && (maxsplit-- > 0)) {
1205 for (; j+n <= len; j++) {
1206 if (Py_STRING_MATCH(s, j, sub, n)) {
1207 SPLIT_ADD(s, i, j);
1208 i = j = j + n;
1209 break;
1210 }
1211 }
1212 }
Neal Norwitz6968b052007-02-27 19:02:19 +00001213#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001214 SPLIT_ADD(s, i, len);
1215 FIX_PREALLOC_SIZE(list);
1216 PyBuffer_Release(&vsub);
1217 return list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001218
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001219 onError:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001220 Py_DECREF(list);
1221 PyBuffer_Release(&vsub);
1222 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001223}
1224
Neal Norwitz6968b052007-02-27 19:02:19 +00001225PyDoc_STRVAR(partition__doc__,
1226"B.partition(sep) -> (head, sep, tail)\n\
1227\n\
Georg Brandl17cb8a82008-05-30 08:20:09 +00001228Search for the separator sep in B, and return the part before it,\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001229the separator itself, and the part after it. If the separator is not\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001230found, returns B and two empty bytes objects.");
Neal Norwitz6968b052007-02-27 19:02:19 +00001231
1232static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001233bytes_partition(PyBytesObject *self, PyObject *sep_obj)
Neal Norwitz6968b052007-02-27 19:02:19 +00001234{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001235 const char *sep;
1236 Py_ssize_t sep_len;
Neal Norwitz6968b052007-02-27 19:02:19 +00001237
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001238 if (PyBytes_Check(sep_obj)) {
1239 sep = PyBytes_AS_STRING(sep_obj);
1240 sep_len = PyBytes_GET_SIZE(sep_obj);
1241 }
1242 else if (PyObject_AsCharBuffer(sep_obj, &sep, &sep_len))
1243 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001244
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001245 return stringlib_partition(
1246 (PyObject*) self,
1247 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
1248 sep_obj, sep, sep_len
1249 );
Neal Norwitz6968b052007-02-27 19:02:19 +00001250}
1251
1252PyDoc_STRVAR(rpartition__doc__,
Ezio Melotti4c81fbb2010-01-25 12:02:24 +00001253"B.rpartition(sep) -> (head, sep, tail)\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001254\n\
Georg Brandl17cb8a82008-05-30 08:20:09 +00001255Search for the separator sep in B, starting at the end of B,\n\
1256and return the part before it, the separator itself, and the\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00001257part after it. If the separator is not found, returns two empty\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001258bytes objects and B.");
Neal Norwitz6968b052007-02-27 19:02:19 +00001259
1260static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001261bytes_rpartition(PyBytesObject *self, PyObject *sep_obj)
Neal Norwitz6968b052007-02-27 19:02:19 +00001262{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001263 const char *sep;
1264 Py_ssize_t sep_len;
Neal Norwitz6968b052007-02-27 19:02:19 +00001265
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001266 if (PyBytes_Check(sep_obj)) {
1267 sep = PyBytes_AS_STRING(sep_obj);
1268 sep_len = PyBytes_GET_SIZE(sep_obj);
1269 }
1270 else if (PyObject_AsCharBuffer(sep_obj, &sep, &sep_len))
1271 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001272
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001273 return stringlib_rpartition(
1274 (PyObject*) self,
1275 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
1276 sep_obj, sep, sep_len
1277 );
Neal Norwitz6968b052007-02-27 19:02:19 +00001278}
1279
1280Py_LOCAL_INLINE(PyObject *)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001281rsplit_whitespace(PyBytesObject *self, Py_ssize_t len, Py_ssize_t maxsplit)
Neal Norwitz6968b052007-02-27 19:02:19 +00001282{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001283 const char *s = PyBytes_AS_STRING(self);
1284 Py_ssize_t i, j, count=0;
1285 PyObject *str;
1286 PyObject *list = PyList_New(PREALLOC_SIZE(maxsplit));
Neal Norwitz6968b052007-02-27 19:02:19 +00001287
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001288 if (list == NULL)
1289 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001290
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001291 i = j = len-1;
Neal Norwitz6968b052007-02-27 19:02:19 +00001292
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001293 while (maxsplit-- > 0) {
1294 RSKIP_SPACE(s, i);
1295 if (i<0) break;
1296 j = i; i--;
1297 RSKIP_NONSPACE(s, i);
1298 if (j == len-1 && i < 0 && PyBytes_CheckExact(self)) {
1299 /* No whitespace in self, so just use it as list[0] */
1300 Py_INCREF(self);
1301 PyList_SET_ITEM(list, 0, (PyObject *)self);
1302 count++;
1303 break;
1304 }
1305 SPLIT_ADD(s, i + 1, j + 1);
1306 }
1307 if (i >= 0) {
1308 /* Only occurs when maxsplit was reached. Skip any remaining
1309 whitespace and copy to beginning of string. */
1310 RSKIP_SPACE(s, i);
1311 if (i >= 0)
1312 SPLIT_ADD(s, 0, i + 1);
Neal Norwitz6968b052007-02-27 19:02:19 +00001313
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001314 }
1315 FIX_PREALLOC_SIZE(list);
1316 if (PyList_Reverse(list) < 0)
1317 goto onError;
1318 return list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001319 onError:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001320 Py_DECREF(list);
1321 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001322}
1323
Guido van Rossum8f950672007-09-10 16:53:45 +00001324Py_LOCAL_INLINE(PyObject *)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001325rsplit_char(PyBytesObject *self, Py_ssize_t len, char ch, Py_ssize_t maxcount)
Guido van Rossum8f950672007-09-10 16:53:45 +00001326{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001327 const char *s = PyBytes_AS_STRING(self);
1328 register Py_ssize_t i, j, count=0;
1329 PyObject *str;
1330 PyObject *list = PyList_New(PREALLOC_SIZE(maxcount));
Guido van Rossum8f950672007-09-10 16:53:45 +00001331
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001332 if (list == NULL)
1333 return NULL;
Guido van Rossum8f950672007-09-10 16:53:45 +00001334
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001335 i = j = len - 1;
1336 while ((i >= 0) && (maxcount-- > 0)) {
1337 for (; i >= 0; i--) {
1338 if (s[i] == ch) {
1339 SPLIT_ADD(s, i + 1, j + 1);
1340 j = i = i - 1;
1341 break;
1342 }
1343 }
1344 }
1345 if (i < 0 && count == 0 && PyBytes_CheckExact(self)) {
1346 /* ch not in self, so just use self as list[0] */
1347 Py_INCREF(self);
1348 PyList_SET_ITEM(list, 0, (PyObject *)self);
1349 count++;
1350 }
1351 else if (j >= -1) {
1352 SPLIT_ADD(s, 0, j + 1);
1353 }
1354 FIX_PREALLOC_SIZE(list);
1355 if (PyList_Reverse(list) < 0)
1356 goto onError;
1357 return list;
Guido van Rossum8f950672007-09-10 16:53:45 +00001358
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001359 onError:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001360 Py_DECREF(list);
1361 return NULL;
Guido van Rossum8f950672007-09-10 16:53:45 +00001362}
1363
Neal Norwitz6968b052007-02-27 19:02:19 +00001364PyDoc_STRVAR(rsplit__doc__,
Benjamin Peterson4116f362008-05-27 00:36:20 +00001365"B.rsplit([sep[, maxsplit]]) -> list of bytes\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001366\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00001367Return a list of the sections in B, using sep as the delimiter,\n\
1368starting at the end of B and working to the front.\n\
Guido van Rossum8f950672007-09-10 16:53:45 +00001369If sep is not given, B is split on ASCII whitespace characters\n\
1370(space, tab, return, newline, formfeed, vertical tab).\n\
1371If maxsplit is given, at most maxsplit splits are done.");
Neal Norwitz6968b052007-02-27 19:02:19 +00001372
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001373
Neal Norwitz6968b052007-02-27 19:02:19 +00001374static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001375bytes_rsplit(PyBytesObject *self, PyObject *args)
Neal Norwitz6968b052007-02-27 19:02:19 +00001376{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001377 Py_ssize_t len = PyBytes_GET_SIZE(self), n, i, j;
1378 Py_ssize_t maxsplit = -1, count=0;
1379 const char *s, *sub;
1380 Py_buffer vsub;
1381 PyObject *list, *str, *subobj = Py_None;
Neal Norwitz6968b052007-02-27 19:02:19 +00001382
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001383 if (!PyArg_ParseTuple(args, "|On:rsplit", &subobj, &maxsplit))
1384 return NULL;
1385 if (maxsplit < 0)
1386 maxsplit = PY_SSIZE_T_MAX;
1387 if (subobj == Py_None)
1388 return rsplit_whitespace(self, len, maxsplit);
1389 if (_getbuffer(subobj, &vsub) < 0)
1390 return NULL;
1391 sub = vsub.buf;
1392 n = vsub.len;
Guido van Rossum8f950672007-09-10 16:53:45 +00001393
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001394 if (n == 0) {
1395 PyErr_SetString(PyExc_ValueError, "empty separator");
1396 PyBuffer_Release(&vsub);
1397 return NULL;
1398 }
1399 else if (n == 1) {
1400 list = rsplit_char(self, len, sub[0], maxsplit);
1401 PyBuffer_Release(&vsub);
1402 return list;
1403 }
Guido van Rossum8f950672007-09-10 16:53:45 +00001404
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001405 list = PyList_New(PREALLOC_SIZE(maxsplit));
1406 if (list == NULL) {
1407 PyBuffer_Release(&vsub);
1408 return NULL;
1409 }
Neal Norwitz6968b052007-02-27 19:02:19 +00001410
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001411 j = len;
1412 i = j - n;
Neal Norwitz6968b052007-02-27 19:02:19 +00001413
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001414 s = PyBytes_AS_STRING(self);
1415 while ( (i >= 0) && (maxsplit-- > 0) ) {
1416 for (; i>=0; i--) {
1417 if (Py_STRING_MATCH(s, i, sub, n)) {
1418 SPLIT_ADD(s, i + n, j);
1419 j = i;
1420 i -= n;
1421 break;
1422 }
1423 }
1424 }
1425 SPLIT_ADD(s, 0, j);
1426 FIX_PREALLOC_SIZE(list);
1427 if (PyList_Reverse(list) < 0)
1428 goto onError;
1429 PyBuffer_Release(&vsub);
1430 return list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001431
1432onError:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001433 Py_DECREF(list);
1434 PyBuffer_Release(&vsub);
1435 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001436}
1437
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001438#undef SPLIT_ADD
1439#undef MAX_PREALLOC
1440#undef PREALLOC_SIZE
1441
1442
1443PyDoc_STRVAR(join__doc__,
1444"B.join(iterable_of_bytes) -> bytes\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001445\n\
Georg Brandl17cb8a82008-05-30 08:20:09 +00001446Concatenate any number of bytes objects, with B in between each pair.\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001447Example: b'.'.join([b'ab', b'pq', b'rs']) -> b'ab.pq.rs'.");
1448
Neal Norwitz6968b052007-02-27 19:02:19 +00001449static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001450bytes_join(PyObject *self, PyObject *orig)
Neal Norwitz6968b052007-02-27 19:02:19 +00001451{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001452 char *sep = PyBytes_AS_STRING(self);
1453 const Py_ssize_t seplen = PyBytes_GET_SIZE(self);
1454 PyObject *res = NULL;
1455 char *p;
1456 Py_ssize_t seqlen = 0;
1457 size_t sz = 0;
1458 Py_ssize_t i;
1459 PyObject *seq, *item;
Neal Norwitz6968b052007-02-27 19:02:19 +00001460
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001461 seq = PySequence_Fast(orig, "");
1462 if (seq == NULL) {
1463 return NULL;
1464 }
Neal Norwitz6968b052007-02-27 19:02:19 +00001465
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001466 seqlen = PySequence_Size(seq);
1467 if (seqlen == 0) {
1468 Py_DECREF(seq);
1469 return PyBytes_FromString("");
1470 }
1471 if (seqlen == 1) {
1472 item = PySequence_Fast_GET_ITEM(seq, 0);
1473 if (PyBytes_CheckExact(item)) {
1474 Py_INCREF(item);
1475 Py_DECREF(seq);
1476 return item;
1477 }
1478 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001479
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001480 /* There are at least two things to join, or else we have a subclass
1481 * of the builtin types in the sequence.
1482 * Do a pre-pass to figure out the total amount of space we'll
1483 * need (sz), and see whether all argument are bytes.
1484 */
1485 /* XXX Shouldn't we use _getbuffer() on these items instead? */
1486 for (i = 0; i < seqlen; i++) {
1487 const size_t old_sz = sz;
1488 item = PySequence_Fast_GET_ITEM(seq, i);
1489 if (!PyBytes_Check(item) && !PyByteArray_Check(item)) {
1490 PyErr_Format(PyExc_TypeError,
1491 "sequence item %zd: expected bytes,"
1492 " %.80s found",
1493 i, Py_TYPE(item)->tp_name);
1494 Py_DECREF(seq);
1495 return NULL;
1496 }
1497 sz += Py_SIZE(item);
1498 if (i != 0)
1499 sz += seplen;
1500 if (sz < old_sz || sz > PY_SSIZE_T_MAX) {
1501 PyErr_SetString(PyExc_OverflowError,
1502 "join() result is too long for bytes");
1503 Py_DECREF(seq);
1504 return NULL;
1505 }
1506 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001507
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001508 /* Allocate result space. */
1509 res = PyBytes_FromStringAndSize((char*)NULL, sz);
1510 if (res == NULL) {
1511 Py_DECREF(seq);
1512 return NULL;
1513 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001514
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001515 /* Catenate everything. */
1516 /* I'm not worried about a PyByteArray item growing because there's
1517 nowhere in this function where we release the GIL. */
1518 p = PyBytes_AS_STRING(res);
1519 for (i = 0; i < seqlen; ++i) {
1520 size_t n;
1521 char *q;
1522 if (i) {
1523 Py_MEMCPY(p, sep, seplen);
1524 p += seplen;
1525 }
1526 item = PySequence_Fast_GET_ITEM(seq, i);
1527 n = Py_SIZE(item);
1528 if (PyBytes_Check(item))
1529 q = PyBytes_AS_STRING(item);
1530 else
1531 q = PyByteArray_AS_STRING(item);
1532 Py_MEMCPY(p, q, n);
1533 p += n;
1534 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001535
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001536 Py_DECREF(seq);
1537 return res;
Neal Norwitz6968b052007-02-27 19:02:19 +00001538}
1539
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001540PyObject *
1541_PyBytes_Join(PyObject *sep, PyObject *x)
1542{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001543 assert(sep != NULL && PyBytes_Check(sep));
1544 assert(x != NULL);
1545 return bytes_join(sep, x);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001546}
1547
1548Py_LOCAL_INLINE(void)
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001549bytes_adjust_indices(Py_ssize_t *start, Py_ssize_t *end, Py_ssize_t len)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001550{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001551 if (*end > len)
1552 *end = len;
1553 else if (*end < 0)
1554 *end += len;
1555 if (*end < 0)
1556 *end = 0;
1557 if (*start < 0)
1558 *start += len;
1559 if (*start < 0)
1560 *start = 0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001561}
1562
1563Py_LOCAL_INLINE(Py_ssize_t)
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001564bytes_find_internal(PyBytesObject *self, PyObject *args, int dir)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001565{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001566 PyObject *subobj;
1567 const char *sub;
1568 Py_ssize_t sub_len;
1569 Py_ssize_t start=0, end=PY_SSIZE_T_MAX;
1570 PyObject *obj_start=Py_None, *obj_end=Py_None;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001571
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001572 if (!PyArg_ParseTuple(args, "O|OO:find/rfind/index/rindex", &subobj,
1573 &obj_start, &obj_end))
1574 return -2;
1575 /* To support None in "start" and "end" arguments, meaning
1576 the same as if they were not passed.
1577 */
1578 if (obj_start != Py_None)
1579 if (!_PyEval_SliceIndex(obj_start, &start))
1580 return -2;
1581 if (obj_end != Py_None)
1582 if (!_PyEval_SliceIndex(obj_end, &end))
1583 return -2;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001584
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001585 if (PyBytes_Check(subobj)) {
1586 sub = PyBytes_AS_STRING(subobj);
1587 sub_len = PyBytes_GET_SIZE(subobj);
1588 }
1589 else if (PyObject_AsCharBuffer(subobj, &sub, &sub_len))
1590 /* XXX - the "expected a character buffer object" is pretty
1591 confusing for a non-expert. remap to something else ? */
1592 return -2;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001593
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001594 if (dir > 0)
1595 return stringlib_find_slice(
1596 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
1597 sub, sub_len, start, end);
1598 else
1599 return stringlib_rfind_slice(
1600 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
1601 sub, sub_len, start, end);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001602}
1603
1604
1605PyDoc_STRVAR(find__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00001606"B.find(sub[, start[, end]]) -> int\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001607\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001608Return the lowest index in S where substring sub is found,\n\
1609such that sub is contained within s[start:end]. Optional\n\
1610arguments start and end are interpreted as in slice notation.\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001611\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001612Return -1 on failure.");
1613
Neal Norwitz6968b052007-02-27 19:02:19 +00001614static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001615bytes_find(PyBytesObject *self, PyObject *args)
Neal Norwitz6968b052007-02-27 19:02:19 +00001616{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001617 Py_ssize_t result = bytes_find_internal(self, args, +1);
1618 if (result == -2)
1619 return NULL;
1620 return PyLong_FromSsize_t(result);
Neal Norwitz6968b052007-02-27 19:02:19 +00001621}
1622
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001623
1624PyDoc_STRVAR(index__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00001625"B.index(sub[, start[, end]]) -> int\n\
Alexandre Vassalotti09121e82007-12-04 05:51:13 +00001626\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001627Like B.find() but raise ValueError when the substring is not found.");
1628
Alexandre Vassalotti09121e82007-12-04 05:51:13 +00001629static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001630bytes_index(PyBytesObject *self, PyObject *args)
Alexandre Vassalotti09121e82007-12-04 05:51:13 +00001631{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001632 Py_ssize_t result = bytes_find_internal(self, args, +1);
1633 if (result == -2)
1634 return NULL;
1635 if (result == -1) {
1636 PyErr_SetString(PyExc_ValueError,
1637 "substring not found");
1638 return NULL;
1639 }
1640 return PyLong_FromSsize_t(result);
Alexandre Vassalotti09121e82007-12-04 05:51:13 +00001641}
1642
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001643
1644PyDoc_STRVAR(rfind__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00001645"B.rfind(sub[, start[, end]]) -> int\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001646\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001647Return the highest index in B where substring sub is found,\n\
1648such that sub is contained within s[start:end]. Optional\n\
1649arguments start and end are interpreted as in slice notation.\n\
Neal Norwitz6968b052007-02-27 19:02:19 +00001650\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001651Return -1 on failure.");
1652
Neal Norwitz6968b052007-02-27 19:02:19 +00001653static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001654bytes_rfind(PyBytesObject *self, PyObject *args)
Neal Norwitz6968b052007-02-27 19:02:19 +00001655{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001656 Py_ssize_t result = bytes_find_internal(self, args, -1);
1657 if (result == -2)
1658 return NULL;
1659 return PyLong_FromSsize_t(result);
Neal Norwitz6968b052007-02-27 19:02:19 +00001660}
1661
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001662
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001663PyDoc_STRVAR(rindex__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00001664"B.rindex(sub[, start[, end]]) -> int\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001665\n\
1666Like B.rfind() but raise ValueError when the substring is not found.");
1667
1668static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001669bytes_rindex(PyBytesObject *self, PyObject *args)
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001670{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001671 Py_ssize_t result = bytes_find_internal(self, args, -1);
1672 if (result == -2)
1673 return NULL;
1674 if (result == -1) {
1675 PyErr_SetString(PyExc_ValueError,
1676 "substring not found");
1677 return NULL;
1678 }
1679 return PyLong_FromSsize_t(result);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001680}
1681
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001682
1683Py_LOCAL_INLINE(PyObject *)
1684do_xstrip(PyBytesObject *self, int striptype, PyObject *sepobj)
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001685{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001686 Py_buffer vsep;
1687 char *s = PyBytes_AS_STRING(self);
1688 Py_ssize_t len = PyBytes_GET_SIZE(self);
1689 char *sep;
1690 Py_ssize_t seplen;
1691 Py_ssize_t i, j;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001692
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001693 if (_getbuffer(sepobj, &vsep) < 0)
1694 return NULL;
1695 sep = vsep.buf;
1696 seplen = vsep.len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001697
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001698 i = 0;
1699 if (striptype != RIGHTSTRIP) {
1700 while (i < len && memchr(sep, Py_CHARMASK(s[i]), seplen)) {
1701 i++;
1702 }
1703 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001704
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001705 j = len;
1706 if (striptype != LEFTSTRIP) {
1707 do {
1708 j--;
1709 } while (j >= i && memchr(sep, Py_CHARMASK(s[j]), seplen));
1710 j++;
1711 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001712
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001713 PyBuffer_Release(&vsep);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001714
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001715 if (i == 0 && j == len && PyBytes_CheckExact(self)) {
1716 Py_INCREF(self);
1717 return (PyObject*)self;
1718 }
1719 else
1720 return PyBytes_FromStringAndSize(s+i, j-i);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001721}
1722
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001723
1724Py_LOCAL_INLINE(PyObject *)
1725do_strip(PyBytesObject *self, int striptype)
1726{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001727 char *s = PyBytes_AS_STRING(self);
1728 Py_ssize_t len = PyBytes_GET_SIZE(self), i, j;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001729
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001730 i = 0;
1731 if (striptype != RIGHTSTRIP) {
1732 while (i < len && ISSPACE(s[i])) {
1733 i++;
1734 }
1735 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001736
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001737 j = len;
1738 if (striptype != LEFTSTRIP) {
1739 do {
1740 j--;
1741 } while (j >= i && ISSPACE(s[j]));
1742 j++;
1743 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001744
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001745 if (i == 0 && j == len && PyBytes_CheckExact(self)) {
1746 Py_INCREF(self);
1747 return (PyObject*)self;
1748 }
1749 else
1750 return PyBytes_FromStringAndSize(s+i, j-i);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001751}
1752
1753
1754Py_LOCAL_INLINE(PyObject *)
1755do_argstrip(PyBytesObject *self, int striptype, PyObject *args)
1756{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001757 PyObject *sep = NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001758
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001759 if (!PyArg_ParseTuple(args, (char *)stripformat[striptype], &sep))
1760 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001761
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001762 if (sep != NULL && sep != Py_None) {
1763 return do_xstrip(self, striptype, sep);
1764 }
1765 return do_strip(self, striptype);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001766}
1767
1768
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001769PyDoc_STRVAR(strip__doc__,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001770"B.strip([bytes]) -> bytes\n\
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001771\n\
Guido van Rossum8f950672007-09-10 16:53:45 +00001772Strip leading and trailing bytes contained in the argument.\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001773If the argument is omitted, strip trailing ASCII whitespace.");
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001774static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001775bytes_strip(PyBytesObject *self, PyObject *args)
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001776{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001777 if (PyTuple_GET_SIZE(args) == 0)
1778 return do_strip(self, BOTHSTRIP); /* Common case */
1779 else
1780 return do_argstrip(self, BOTHSTRIP, args);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001781}
1782
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001783
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001784PyDoc_STRVAR(lstrip__doc__,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001785"B.lstrip([bytes]) -> bytes\n\
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001786\n\
Guido van Rossum8f950672007-09-10 16:53:45 +00001787Strip leading bytes contained in the argument.\n\
1788If the argument is omitted, strip leading ASCII whitespace.");
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001789static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001790bytes_lstrip(PyBytesObject *self, PyObject *args)
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001791{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001792 if (PyTuple_GET_SIZE(args) == 0)
1793 return do_strip(self, LEFTSTRIP); /* Common case */
1794 else
1795 return do_argstrip(self, LEFTSTRIP, args);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001796}
1797
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001798
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001799PyDoc_STRVAR(rstrip__doc__,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001800"B.rstrip([bytes]) -> bytes\n\
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001801\n\
Guido van Rossum8f950672007-09-10 16:53:45 +00001802Strip trailing bytes contained in the argument.\n\
1803If the argument is omitted, strip trailing ASCII whitespace.");
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001804static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001805bytes_rstrip(PyBytesObject *self, PyObject *args)
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001806{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001807 if (PyTuple_GET_SIZE(args) == 0)
1808 return do_strip(self, RIGHTSTRIP); /* Common case */
1809 else
1810 return do_argstrip(self, RIGHTSTRIP, args);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001811}
Neal Norwitz6968b052007-02-27 19:02:19 +00001812
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001813
1814PyDoc_STRVAR(count__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00001815"B.count(sub[, start[, end]]) -> int\n\
Guido van Rossumd624f182006-04-24 13:47:05 +00001816\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001817Return the number of non-overlapping occurrences of substring sub in\n\
1818string S[start:end]. Optional arguments start and end are interpreted\n\
1819as in slice notation.");
1820
1821static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001822bytes_count(PyBytesObject *self, PyObject *args)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001823{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001824 PyObject *sub_obj;
1825 const char *str = PyBytes_AS_STRING(self), *sub;
1826 Py_ssize_t sub_len;
1827 Py_ssize_t start = 0, end = PY_SSIZE_T_MAX;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001828
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001829 if (!PyArg_ParseTuple(args, "O|O&O&:count", &sub_obj,
1830 _PyEval_SliceIndex, &start, _PyEval_SliceIndex, &end))
1831 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001832
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001833 if (PyBytes_Check(sub_obj)) {
1834 sub = PyBytes_AS_STRING(sub_obj);
1835 sub_len = PyBytes_GET_SIZE(sub_obj);
1836 }
1837 else if (PyObject_AsCharBuffer(sub_obj, &sub, &sub_len))
1838 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001839
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001840 bytes_adjust_indices(&start, &end, PyBytes_GET_SIZE(self));
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001841
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001842 return PyLong_FromSsize_t(
1843 stringlib_count(str + start, end - start, sub, sub_len)
1844 );
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001845}
1846
1847
1848PyDoc_STRVAR(translate__doc__,
1849"B.translate(table[, deletechars]) -> bytes\n\
1850\n\
1851Return a copy of B, where all characters occurring in the\n\
1852optional argument deletechars are removed, and the remaining\n\
1853characters have been mapped through the given translation\n\
1854table, which must be a bytes object of length 256.");
1855
1856static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001857bytes_translate(PyBytesObject *self, PyObject *args)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001858{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001859 register char *input, *output;
1860 const char *table;
1861 register Py_ssize_t i, c, changed = 0;
1862 PyObject *input_obj = (PyObject*)self;
1863 const char *output_start, *del_table=NULL;
1864 Py_ssize_t inlen, tablen, dellen = 0;
1865 PyObject *result;
1866 int trans_table[256];
1867 PyObject *tableobj, *delobj = NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001868
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001869 if (!PyArg_UnpackTuple(args, "translate", 1, 2,
1870 &tableobj, &delobj))
1871 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001872
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001873 if (PyBytes_Check(tableobj)) {
1874 table = PyBytes_AS_STRING(tableobj);
1875 tablen = PyBytes_GET_SIZE(tableobj);
1876 }
1877 else if (tableobj == Py_None) {
1878 table = NULL;
1879 tablen = 256;
1880 }
1881 else if (PyObject_AsCharBuffer(tableobj, &table, &tablen))
1882 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001883
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001884 if (tablen != 256) {
1885 PyErr_SetString(PyExc_ValueError,
1886 "translation table must be 256 characters long");
1887 return NULL;
1888 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001889
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001890 if (delobj != NULL) {
1891 if (PyBytes_Check(delobj)) {
1892 del_table = PyBytes_AS_STRING(delobj);
1893 dellen = PyBytes_GET_SIZE(delobj);
1894 }
1895 else if (PyObject_AsCharBuffer(delobj, &del_table, &dellen))
1896 return NULL;
1897 }
1898 else {
1899 del_table = NULL;
1900 dellen = 0;
1901 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001902
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001903 inlen = PyBytes_GET_SIZE(input_obj);
1904 result = PyBytes_FromStringAndSize((char *)NULL, inlen);
1905 if (result == NULL)
1906 return NULL;
1907 output_start = output = PyBytes_AsString(result);
1908 input = PyBytes_AS_STRING(input_obj);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001909
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001910 if (dellen == 0 && table != NULL) {
1911 /* If no deletions are required, use faster code */
1912 for (i = inlen; --i >= 0; ) {
1913 c = Py_CHARMASK(*input++);
1914 if (Py_CHARMASK((*output++ = table[c])) != c)
1915 changed = 1;
1916 }
1917 if (changed || !PyBytes_CheckExact(input_obj))
1918 return result;
1919 Py_DECREF(result);
1920 Py_INCREF(input_obj);
1921 return input_obj;
1922 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001923
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001924 if (table == NULL) {
1925 for (i = 0; i < 256; i++)
1926 trans_table[i] = Py_CHARMASK(i);
1927 } else {
1928 for (i = 0; i < 256; i++)
1929 trans_table[i] = Py_CHARMASK(table[i]);
1930 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001931
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001932 for (i = 0; i < dellen; i++)
1933 trans_table[(int) Py_CHARMASK(del_table[i])] = -1;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001934
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001935 for (i = inlen; --i >= 0; ) {
1936 c = Py_CHARMASK(*input++);
1937 if (trans_table[c] != -1)
1938 if (Py_CHARMASK(*output++ = (char)trans_table[c]) == c)
1939 continue;
1940 changed = 1;
1941 }
1942 if (!changed && PyBytes_CheckExact(input_obj)) {
1943 Py_DECREF(result);
1944 Py_INCREF(input_obj);
1945 return input_obj;
1946 }
1947 /* Fix the size of the resulting string */
1948 if (inlen > 0)
1949 _PyBytes_Resize(&result, output - output_start);
1950 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001951}
1952
1953
Georg Brandlabc38772009-04-12 15:51:51 +00001954static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001955bytes_maketrans(PyObject *null, PyObject *args)
Georg Brandlabc38772009-04-12 15:51:51 +00001956{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001957 return _Py_bytes_maketrans(args);
Georg Brandlabc38772009-04-12 15:51:51 +00001958}
1959
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001960#define FORWARD 1
1961#define REVERSE -1
1962
1963/* find and count characters and substrings */
1964
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001965#define findchar(target, target_len, c) \
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001966 ((char *)memchr((const void *)(target), c, target_len))
1967
1968/* String ops must return a string. */
1969/* If the object is subclass of string, create a copy */
1970Py_LOCAL(PyBytesObject *)
1971return_self(PyBytesObject *self)
1972{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001973 if (PyBytes_CheckExact(self)) {
1974 Py_INCREF(self);
1975 return self;
1976 }
1977 return (PyBytesObject *)PyBytes_FromStringAndSize(
1978 PyBytes_AS_STRING(self),
1979 PyBytes_GET_SIZE(self));
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001980}
1981
1982Py_LOCAL_INLINE(Py_ssize_t)
1983countchar(const char *target, int target_len, char c, Py_ssize_t maxcount)
1984{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001985 Py_ssize_t count=0;
1986 const char *start=target;
1987 const char *end=target+target_len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001988
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001989 while ( (start=findchar(start, end-start, c)) != NULL ) {
1990 count++;
1991 if (count >= maxcount)
1992 break;
1993 start += 1;
1994 }
1995 return count;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001996}
1997
1998Py_LOCAL(Py_ssize_t)
1999findstring(const char *target, Py_ssize_t target_len,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002000 const char *pattern, Py_ssize_t pattern_len,
2001 Py_ssize_t start,
2002 Py_ssize_t end,
2003 int direction)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002004{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002005 if (start < 0) {
2006 start += target_len;
2007 if (start < 0)
2008 start = 0;
2009 }
2010 if (end > target_len) {
2011 end = target_len;
2012 } else if (end < 0) {
2013 end += target_len;
2014 if (end < 0)
2015 end = 0;
2016 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002017
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002018 /* zero-length substrings always match at the first attempt */
2019 if (pattern_len == 0)
2020 return (direction > 0) ? start : end;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002021
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002022 end -= pattern_len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002023
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002024 if (direction < 0) {
2025 for (; end >= start; end--)
2026 if (Py_STRING_MATCH(target, end, pattern, pattern_len))
2027 return end;
2028 } else {
2029 for (; start <= end; start++)
2030 if (Py_STRING_MATCH(target, start,pattern,pattern_len))
2031 return start;
2032 }
2033 return -1;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002034}
2035
2036Py_LOCAL_INLINE(Py_ssize_t)
2037countstring(const char *target, Py_ssize_t target_len,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002038 const char *pattern, Py_ssize_t pattern_len,
2039 Py_ssize_t start,
2040 Py_ssize_t end,
2041 int direction, Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002042{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002043 Py_ssize_t count=0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002044
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002045 if (start < 0) {
2046 start += target_len;
2047 if (start < 0)
2048 start = 0;
2049 }
2050 if (end > target_len) {
2051 end = target_len;
2052 } else if (end < 0) {
2053 end += target_len;
2054 if (end < 0)
2055 end = 0;
2056 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002057
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002058 /* zero-length substrings match everywhere */
2059 if (pattern_len == 0 || maxcount == 0) {
2060 if (target_len+1 < maxcount)
2061 return target_len+1;
2062 return maxcount;
2063 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002064
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002065 end -= pattern_len;
2066 if (direction < 0) {
2067 for (; (end >= start); end--)
2068 if (Py_STRING_MATCH(target, end,pattern,pattern_len)) {
2069 count++;
2070 if (--maxcount <= 0) break;
2071 end -= pattern_len-1;
2072 }
2073 } else {
2074 for (; (start <= end); start++)
2075 if (Py_STRING_MATCH(target, start,
2076 pattern, pattern_len)) {
2077 count++;
2078 if (--maxcount <= 0)
2079 break;
2080 start += pattern_len-1;
2081 }
2082 }
2083 return count;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002084}
2085
2086
2087/* Algorithms for different cases of string replacement */
2088
2089/* len(self)>=1, from="", len(to)>=1, maxcount>=1 */
2090Py_LOCAL(PyBytesObject *)
2091replace_interleave(PyBytesObject *self,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002092 const char *to_s, Py_ssize_t to_len,
2093 Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002094{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002095 char *self_s, *result_s;
2096 Py_ssize_t self_len, result_len;
2097 Py_ssize_t count, i, product;
2098 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002099
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002100 self_len = PyBytes_GET_SIZE(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002101
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002102 /* 1 at the end plus 1 after every character */
2103 count = self_len+1;
2104 if (maxcount < count)
2105 count = maxcount;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002106
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002107 /* Check for overflow */
2108 /* result_len = count * to_len + self_len; */
2109 product = count * to_len;
2110 if (product / to_len != count) {
2111 PyErr_SetString(PyExc_OverflowError,
2112 "replacement bytes are too long");
2113 return NULL;
2114 }
2115 result_len = product + self_len;
2116 if (result_len < 0) {
2117 PyErr_SetString(PyExc_OverflowError,
2118 "replacement bytes are too long");
2119 return NULL;
2120 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002121
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002122 if (! (result = (PyBytesObject *)
2123 PyBytes_FromStringAndSize(NULL, result_len)) )
2124 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002125
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002126 self_s = PyBytes_AS_STRING(self);
2127 result_s = PyBytes_AS_STRING(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002128
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002129 /* TODO: special case single character, which doesn't need memcpy */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002130
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002131 /* Lay the first one down (guaranteed this will occur) */
2132 Py_MEMCPY(result_s, to_s, to_len);
2133 result_s += to_len;
2134 count -= 1;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002135
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002136 for (i=0; i<count; i++) {
2137 *result_s++ = *self_s++;
2138 Py_MEMCPY(result_s, to_s, to_len);
2139 result_s += to_len;
2140 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002141
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002142 /* Copy the rest of the original string */
2143 Py_MEMCPY(result_s, self_s, self_len-i);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002144
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002145 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002146}
2147
2148/* Special case for deleting a single character */
2149/* len(self)>=1, len(from)==1, to="", maxcount>=1 */
2150Py_LOCAL(PyBytesObject *)
2151replace_delete_single_character(PyBytesObject *self,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002152 char from_c, Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002153{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002154 char *self_s, *result_s;
2155 char *start, *next, *end;
2156 Py_ssize_t self_len, result_len;
2157 Py_ssize_t count;
2158 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002159
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002160 self_len = PyBytes_GET_SIZE(self);
2161 self_s = PyBytes_AS_STRING(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002162
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002163 count = countchar(self_s, self_len, from_c, maxcount);
2164 if (count == 0) {
2165 return return_self(self);
2166 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002167
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002168 result_len = self_len - count; /* from_len == 1 */
2169 assert(result_len>=0);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002170
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002171 if ( (result = (PyBytesObject *)
2172 PyBytes_FromStringAndSize(NULL, result_len)) == NULL)
2173 return NULL;
2174 result_s = PyBytes_AS_STRING(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002175
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002176 start = self_s;
2177 end = self_s + self_len;
2178 while (count-- > 0) {
2179 next = findchar(start, end-start, from_c);
2180 if (next == NULL)
2181 break;
2182 Py_MEMCPY(result_s, start, next-start);
2183 result_s += (next-start);
2184 start = next+1;
2185 }
2186 Py_MEMCPY(result_s, start, end-start);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002187
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002188 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002189}
2190
2191/* len(self)>=1, len(from)>=2, to="", maxcount>=1 */
2192
2193Py_LOCAL(PyBytesObject *)
2194replace_delete_substring(PyBytesObject *self,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002195 const char *from_s, Py_ssize_t from_len,
2196 Py_ssize_t maxcount) {
2197 char *self_s, *result_s;
2198 char *start, *next, *end;
2199 Py_ssize_t self_len, result_len;
2200 Py_ssize_t count, offset;
2201 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002202
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002203 self_len = PyBytes_GET_SIZE(self);
2204 self_s = PyBytes_AS_STRING(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002205
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002206 count = countstring(self_s, self_len,
2207 from_s, from_len,
2208 0, self_len, 1,
2209 maxcount);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002210
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002211 if (count == 0) {
2212 /* no matches */
2213 return return_self(self);
2214 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002215
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002216 result_len = self_len - (count * from_len);
2217 assert (result_len>=0);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002218
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002219 if ( (result = (PyBytesObject *)
2220 PyBytes_FromStringAndSize(NULL, result_len)) == NULL )
2221 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002222
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002223 result_s = PyBytes_AS_STRING(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002224
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002225 start = self_s;
2226 end = self_s + self_len;
2227 while (count-- > 0) {
2228 offset = findstring(start, end-start,
2229 from_s, from_len,
2230 0, end-start, FORWARD);
2231 if (offset == -1)
2232 break;
2233 next = start + offset;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002234
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002235 Py_MEMCPY(result_s, start, next-start);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002236
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002237 result_s += (next-start);
2238 start = next+from_len;
2239 }
2240 Py_MEMCPY(result_s, start, end-start);
2241 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002242}
2243
2244/* len(self)>=1, len(from)==len(to)==1, maxcount>=1 */
2245Py_LOCAL(PyBytesObject *)
2246replace_single_character_in_place(PyBytesObject *self,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002247 char from_c, char to_c,
2248 Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002249{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002250 char *self_s, *result_s, *start, *end, *next;
2251 Py_ssize_t self_len;
2252 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002253
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002254 /* The result string will be the same size */
2255 self_s = PyBytes_AS_STRING(self);
2256 self_len = PyBytes_GET_SIZE(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002257
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002258 next = findchar(self_s, self_len, from_c);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002259
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002260 if (next == NULL) {
2261 /* No matches; return the original string */
2262 return return_self(self);
2263 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002264
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002265 /* Need to make a new string */
2266 result = (PyBytesObject *) PyBytes_FromStringAndSize(NULL, self_len);
2267 if (result == NULL)
2268 return NULL;
2269 result_s = PyBytes_AS_STRING(result);
2270 Py_MEMCPY(result_s, self_s, self_len);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002271
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002272 /* change everything in-place, starting with this one */
2273 start = result_s + (next-self_s);
2274 *start = to_c;
2275 start++;
2276 end = result_s + self_len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002277
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002278 while (--maxcount > 0) {
2279 next = findchar(start, end-start, from_c);
2280 if (next == NULL)
2281 break;
2282 *next = to_c;
2283 start = next+1;
2284 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002285
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002286 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002287}
2288
2289/* len(self)>=1, len(from)==len(to)>=2, maxcount>=1 */
2290Py_LOCAL(PyBytesObject *)
2291replace_substring_in_place(PyBytesObject *self,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002292 const char *from_s, Py_ssize_t from_len,
2293 const char *to_s, Py_ssize_t to_len,
2294 Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002295{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002296 char *result_s, *start, *end;
2297 char *self_s;
2298 Py_ssize_t self_len, offset;
2299 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002300
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002301 /* The result string will be the same size */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002302
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002303 self_s = PyBytes_AS_STRING(self);
2304 self_len = PyBytes_GET_SIZE(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002305
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002306 offset = findstring(self_s, self_len,
2307 from_s, from_len,
2308 0, self_len, FORWARD);
2309 if (offset == -1) {
2310 /* No matches; return the original string */
2311 return return_self(self);
2312 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002313
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002314 /* Need to make a new string */
2315 result = (PyBytesObject *) PyBytes_FromStringAndSize(NULL, self_len);
2316 if (result == NULL)
2317 return NULL;
2318 result_s = PyBytes_AS_STRING(result);
2319 Py_MEMCPY(result_s, self_s, self_len);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002320
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002321 /* change everything in-place, starting with this one */
2322 start = result_s + offset;
2323 Py_MEMCPY(start, to_s, from_len);
2324 start += from_len;
2325 end = result_s + self_len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002326
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002327 while ( --maxcount > 0) {
2328 offset = findstring(start, end-start,
2329 from_s, from_len,
2330 0, end-start, FORWARD);
2331 if (offset==-1)
2332 break;
2333 Py_MEMCPY(start+offset, to_s, from_len);
2334 start += offset+from_len;
2335 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002336
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002337 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002338}
2339
2340/* len(self)>=1, len(from)==1, len(to)>=2, maxcount>=1 */
2341Py_LOCAL(PyBytesObject *)
2342replace_single_character(PyBytesObject *self,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002343 char from_c,
2344 const char *to_s, Py_ssize_t to_len,
2345 Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002346{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002347 char *self_s, *result_s;
2348 char *start, *next, *end;
2349 Py_ssize_t self_len, result_len;
2350 Py_ssize_t count, product;
2351 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002352
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002353 self_s = PyBytes_AS_STRING(self);
2354 self_len = PyBytes_GET_SIZE(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002355
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002356 count = countchar(self_s, self_len, from_c, maxcount);
2357 if (count == 0) {
2358 /* no matches, return unchanged */
2359 return return_self(self);
2360 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002361
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002362 /* use the difference between current and new, hence the "-1" */
2363 /* result_len = self_len + count * (to_len-1) */
2364 product = count * (to_len-1);
2365 if (product / (to_len-1) != count) {
2366 PyErr_SetString(PyExc_OverflowError,
2367 "replacement bytes are too long");
2368 return NULL;
2369 }
2370 result_len = self_len + product;
2371 if (result_len < 0) {
2372 PyErr_SetString(PyExc_OverflowError,
2373 "replacment bytes are too long");
2374 return NULL;
2375 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002376
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002377 if ( (result = (PyBytesObject *)
2378 PyBytes_FromStringAndSize(NULL, result_len)) == NULL)
2379 return NULL;
2380 result_s = PyBytes_AS_STRING(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002381
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002382 start = self_s;
2383 end = self_s + self_len;
2384 while (count-- > 0) {
2385 next = findchar(start, end-start, from_c);
2386 if (next == NULL)
2387 break;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002388
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002389 if (next == start) {
2390 /* replace with the 'to' */
2391 Py_MEMCPY(result_s, to_s, to_len);
2392 result_s += to_len;
2393 start += 1;
2394 } else {
2395 /* copy the unchanged old then the 'to' */
2396 Py_MEMCPY(result_s, start, next-start);
2397 result_s += (next-start);
2398 Py_MEMCPY(result_s, to_s, to_len);
2399 result_s += to_len;
2400 start = next+1;
2401 }
2402 }
2403 /* Copy the remainder of the remaining string */
2404 Py_MEMCPY(result_s, start, end-start);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002405
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002406 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002407}
2408
2409/* len(self)>=1, len(from)>=2, len(to)>=2, maxcount>=1 */
2410Py_LOCAL(PyBytesObject *)
2411replace_substring(PyBytesObject *self,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002412 const char *from_s, Py_ssize_t from_len,
2413 const char *to_s, Py_ssize_t to_len,
2414 Py_ssize_t maxcount) {
2415 char *self_s, *result_s;
2416 char *start, *next, *end;
2417 Py_ssize_t self_len, result_len;
2418 Py_ssize_t count, offset, product;
2419 PyBytesObject *result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002420
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002421 self_s = PyBytes_AS_STRING(self);
2422 self_len = PyBytes_GET_SIZE(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002423
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002424 count = countstring(self_s, self_len,
2425 from_s, from_len,
2426 0, self_len, FORWARD, maxcount);
2427 if (count == 0) {
2428 /* no matches, return unchanged */
2429 return return_self(self);
2430 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002431
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002432 /* Check for overflow */
2433 /* result_len = self_len + count * (to_len-from_len) */
2434 product = count * (to_len-from_len);
2435 if (product / (to_len-from_len) != count) {
2436 PyErr_SetString(PyExc_OverflowError,
2437 "replacement bytes are too long");
2438 return NULL;
2439 }
2440 result_len = self_len + product;
2441 if (result_len < 0) {
2442 PyErr_SetString(PyExc_OverflowError,
2443 "replacement bytes are too long");
2444 return NULL;
2445 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002446
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002447 if ( (result = (PyBytesObject *)
2448 PyBytes_FromStringAndSize(NULL, result_len)) == NULL)
2449 return NULL;
2450 result_s = PyBytes_AS_STRING(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002451
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002452 start = self_s;
2453 end = self_s + self_len;
2454 while (count-- > 0) {
2455 offset = findstring(start, end-start,
2456 from_s, from_len,
2457 0, end-start, FORWARD);
2458 if (offset == -1)
2459 break;
2460 next = start+offset;
2461 if (next == start) {
2462 /* replace with the 'to' */
2463 Py_MEMCPY(result_s, to_s, to_len);
2464 result_s += to_len;
2465 start += from_len;
2466 } else {
2467 /* copy the unchanged old then the 'to' */
2468 Py_MEMCPY(result_s, start, next-start);
2469 result_s += (next-start);
2470 Py_MEMCPY(result_s, to_s, to_len);
2471 result_s += to_len;
2472 start = next+from_len;
2473 }
2474 }
2475 /* Copy the remainder of the remaining string */
2476 Py_MEMCPY(result_s, start, end-start);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002477
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002478 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002479}
2480
2481
2482Py_LOCAL(PyBytesObject *)
2483replace(PyBytesObject *self,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002484 const char *from_s, Py_ssize_t from_len,
2485 const char *to_s, Py_ssize_t to_len,
2486 Py_ssize_t maxcount)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002487{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002488 if (maxcount < 0) {
2489 maxcount = PY_SSIZE_T_MAX;
2490 } else if (maxcount == 0 || PyBytes_GET_SIZE(self) == 0) {
2491 /* nothing to do; return the original string */
2492 return return_self(self);
2493 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002494
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002495 if (maxcount == 0 ||
2496 (from_len == 0 && to_len == 0)) {
2497 /* nothing to do; return the original string */
2498 return return_self(self);
2499 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002500
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002501 /* Handle zero-length special cases */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002502
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002503 if (from_len == 0) {
2504 /* insert the 'to' string everywhere. */
2505 /* >>> "Python".replace("", ".") */
2506 /* '.P.y.t.h.o.n.' */
2507 return replace_interleave(self, to_s, to_len, maxcount);
2508 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002509
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002510 /* Except for "".replace("", "A") == "A" there is no way beyond this */
2511 /* point for an empty self string to generate a non-empty string */
2512 /* Special case so the remaining code always gets a non-empty string */
2513 if (PyBytes_GET_SIZE(self) == 0) {
2514 return return_self(self);
2515 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002516
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002517 if (to_len == 0) {
2518 /* delete all occurrences of 'from' string */
2519 if (from_len == 1) {
2520 return replace_delete_single_character(
2521 self, from_s[0], maxcount);
2522 } else {
2523 return replace_delete_substring(self, from_s,
2524 from_len, maxcount);
2525 }
2526 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002527
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002528 /* Handle special case where both strings have the same length */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002529
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002530 if (from_len == to_len) {
2531 if (from_len == 1) {
2532 return replace_single_character_in_place(
2533 self,
2534 from_s[0],
2535 to_s[0],
2536 maxcount);
2537 } else {
2538 return replace_substring_in_place(
2539 self, from_s, from_len, to_s, to_len,
2540 maxcount);
2541 }
2542 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002543
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002544 /* Otherwise use the more generic algorithms */
2545 if (from_len == 1) {
2546 return replace_single_character(self, from_s[0],
2547 to_s, to_len, maxcount);
2548 } else {
2549 /* len('from')>=2, len('to')>=1 */
2550 return replace_substring(self, from_s, from_len, to_s, to_len,
2551 maxcount);
2552 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002553}
2554
2555PyDoc_STRVAR(replace__doc__,
2556"B.replace(old, new[, count]) -> bytes\n\
2557\n\
2558Return a copy of B with all occurrences of subsection\n\
2559old replaced by new. If the optional argument count is\n\
Senthil Kumarana3aee532010-08-09 09:02:18 +00002560positive, only the first count occurrences are replaced. A\n\
Senthil Kumaranc3ce8822010-08-09 09:06:23 +00002561negative value of count replaces all occurrences");
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002562
2563static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002564bytes_replace(PyBytesObject *self, PyObject *args)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002565{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002566 Py_ssize_t count = -1;
2567 PyObject *from, *to;
2568 const char *from_s, *to_s;
2569 Py_ssize_t from_len, to_len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002570
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002571 if (!PyArg_ParseTuple(args, "OO|n:replace", &from, &to, &count))
2572 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002573
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002574 if (PyBytes_Check(from)) {
2575 from_s = PyBytes_AS_STRING(from);
2576 from_len = PyBytes_GET_SIZE(from);
2577 }
2578 else if (PyObject_AsCharBuffer(from, &from_s, &from_len))
2579 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002580
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002581 if (PyBytes_Check(to)) {
2582 to_s = PyBytes_AS_STRING(to);
2583 to_len = PyBytes_GET_SIZE(to);
2584 }
2585 else if (PyObject_AsCharBuffer(to, &to_s, &to_len))
2586 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002587
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002588 return (PyObject *)replace((PyBytesObject *) self,
2589 from_s, from_len,
2590 to_s, to_len, count);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002591}
2592
2593/** End DALKE **/
2594
2595/* Matches the end (direction >= 0) or start (direction < 0) of self
2596 * against substr, using the start and end arguments. Returns
2597 * -1 on error, 0 if not found and 1 if found.
2598 */
2599Py_LOCAL(int)
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002600_bytes_tailmatch(PyBytesObject *self, PyObject *substr, Py_ssize_t start,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002601 Py_ssize_t end, int direction)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002602{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002603 Py_ssize_t len = PyBytes_GET_SIZE(self);
2604 Py_ssize_t slen;
2605 const char* sub;
2606 const char* str;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002607
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002608 if (PyBytes_Check(substr)) {
2609 sub = PyBytes_AS_STRING(substr);
2610 slen = PyBytes_GET_SIZE(substr);
2611 }
2612 else if (PyObject_AsCharBuffer(substr, &sub, &slen))
2613 return -1;
2614 str = PyBytes_AS_STRING(self);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002615
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002616 bytes_adjust_indices(&start, &end, len);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002617
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002618 if (direction < 0) {
2619 /* startswith */
2620 if (start+slen > len)
2621 return 0;
2622 } else {
2623 /* endswith */
2624 if (end-start < slen || start > len)
2625 return 0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002626
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002627 if (end-slen > start)
2628 start = end - slen;
2629 }
2630 if (end-start >= slen)
2631 return ! memcmp(str+start, sub, slen);
2632 return 0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002633}
2634
2635
2636PyDoc_STRVAR(startswith__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00002637"B.startswith(prefix[, start[, end]]) -> bool\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002638\n\
2639Return True if B starts with the specified prefix, False otherwise.\n\
2640With optional start, test B beginning at that position.\n\
2641With optional end, stop comparing B at that position.\n\
Benjamin Peterson4116f362008-05-27 00:36:20 +00002642prefix can also be a tuple of bytes to try.");
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002643
2644static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002645bytes_startswith(PyBytesObject *self, PyObject *args)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002646{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002647 Py_ssize_t start = 0;
2648 Py_ssize_t end = PY_SSIZE_T_MAX;
2649 PyObject *subobj;
2650 int result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002651
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002652 if (!PyArg_ParseTuple(args, "O|O&O&:startswith", &subobj,
2653 _PyEval_SliceIndex, &start, _PyEval_SliceIndex, &end))
2654 return NULL;
2655 if (PyTuple_Check(subobj)) {
2656 Py_ssize_t i;
2657 for (i = 0; i < PyTuple_GET_SIZE(subobj); i++) {
2658 result = _bytes_tailmatch(self,
2659 PyTuple_GET_ITEM(subobj, i),
2660 start, end, -1);
2661 if (result == -1)
2662 return NULL;
2663 else if (result) {
2664 Py_RETURN_TRUE;
2665 }
2666 }
2667 Py_RETURN_FALSE;
2668 }
2669 result = _bytes_tailmatch(self, subobj, start, end, -1);
2670 if (result == -1)
2671 return NULL;
2672 else
2673 return PyBool_FromLong(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002674}
2675
2676
2677PyDoc_STRVAR(endswith__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00002678"B.endswith(suffix[, start[, end]]) -> bool\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002679\n\
2680Return True if B ends with the specified suffix, False otherwise.\n\
2681With optional start, test B beginning at that position.\n\
2682With optional end, stop comparing B at that position.\n\
Benjamin Peterson4116f362008-05-27 00:36:20 +00002683suffix can also be a tuple of bytes to try.");
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002684
2685static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002686bytes_endswith(PyBytesObject *self, PyObject *args)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002687{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002688 Py_ssize_t start = 0;
2689 Py_ssize_t end = PY_SSIZE_T_MAX;
2690 PyObject *subobj;
2691 int result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002692
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002693 if (!PyArg_ParseTuple(args, "O|O&O&:endswith", &subobj,
2694 _PyEval_SliceIndex, &start, _PyEval_SliceIndex, &end))
2695 return NULL;
2696 if (PyTuple_Check(subobj)) {
2697 Py_ssize_t i;
2698 for (i = 0; i < PyTuple_GET_SIZE(subobj); i++) {
2699 result = _bytes_tailmatch(self,
2700 PyTuple_GET_ITEM(subobj, i),
2701 start, end, +1);
2702 if (result == -1)
2703 return NULL;
2704 else if (result) {
2705 Py_RETURN_TRUE;
2706 }
2707 }
2708 Py_RETURN_FALSE;
2709 }
2710 result = _bytes_tailmatch(self, subobj, start, end, +1);
2711 if (result == -1)
2712 return NULL;
2713 else
2714 return PyBool_FromLong(result);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002715}
2716
2717
2718PyDoc_STRVAR(decode__doc__,
Georg Brandl17cb8a82008-05-30 08:20:09 +00002719"B.decode([encoding[, errors]]) -> str\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002720\n\
Georg Brandl17cb8a82008-05-30 08:20:09 +00002721Decode S using the codec registered for encoding. encoding defaults\n\
Guido van Rossumd624f182006-04-24 13:47:05 +00002722to the default encoding. errors may be given to set a different error\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00002723handling scheme. Default is 'strict' meaning that encoding errors raise\n\
2724a UnicodeDecodeError. Other possible values are 'ignore' and 'replace'\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002725as well as any other name registerd with codecs.register_error that is\n\
Guido van Rossumd624f182006-04-24 13:47:05 +00002726able to handle UnicodeDecodeErrors.");
2727
2728static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002729bytes_decode(PyObject *self, PyObject *args)
Guido van Rossumb6f1fdc2007-04-12 22:49:52 +00002730{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002731 const char *encoding = NULL;
2732 const char *errors = NULL;
Guido van Rossumd624f182006-04-24 13:47:05 +00002733
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002734 if (!PyArg_ParseTuple(args, "|ss:decode", &encoding, &errors))
2735 return NULL;
2736 if (encoding == NULL)
2737 encoding = PyUnicode_GetDefaultEncoding();
2738 return PyUnicode_FromEncodedObject(self, encoding, errors);
Guido van Rossumd624f182006-04-24 13:47:05 +00002739}
2740
Guido van Rossum20188312006-05-05 15:15:40 +00002741
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002742PyDoc_STRVAR(fromhex_doc,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002743"bytes.fromhex(string) -> bytes\n\
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002744\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002745Create a bytes object from a string of hexadecimal numbers.\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00002746Spaces between two numbers are accepted.\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002747Example: bytes.fromhex('B9 01EF') -> b'\\xb9\\x01\\xef'.");
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002748
2749static int
Guido van Rossumae404e22007-10-26 21:46:44 +00002750hex_digit_to_int(Py_UNICODE c)
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002751{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002752 if (c >= 128)
2753 return -1;
2754 if (ISDIGIT(c))
2755 return c - '0';
2756 else {
2757 if (ISUPPER(c))
2758 c = TOLOWER(c);
2759 if (c >= 'a' && c <= 'f')
2760 return c - 'a' + 10;
2761 }
2762 return -1;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002763}
2764
2765static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002766bytes_fromhex(PyObject *cls, PyObject *args)
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002767{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002768 PyObject *newstring, *hexobj;
2769 char *buf;
2770 Py_UNICODE *hex;
2771 Py_ssize_t hexlen, byteslen, i, j;
2772 int top, bot;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002773
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002774 if (!PyArg_ParseTuple(args, "U:fromhex", &hexobj))
2775 return NULL;
2776 assert(PyUnicode_Check(hexobj));
2777 hexlen = PyUnicode_GET_SIZE(hexobj);
2778 hex = PyUnicode_AS_UNICODE(hexobj);
2779 byteslen = hexlen/2; /* This overestimates if there are spaces */
2780 newstring = PyBytes_FromStringAndSize(NULL, byteslen);
2781 if (!newstring)
2782 return NULL;
2783 buf = PyBytes_AS_STRING(newstring);
2784 for (i = j = 0; i < hexlen; i += 2) {
2785 /* skip over spaces in the input */
2786 while (hex[i] == ' ')
2787 i++;
2788 if (i >= hexlen)
2789 break;
2790 top = hex_digit_to_int(hex[i]);
2791 bot = hex_digit_to_int(hex[i+1]);
2792 if (top == -1 || bot == -1) {
2793 PyErr_Format(PyExc_ValueError,
2794 "non-hexadecimal number found in "
2795 "fromhex() arg at position %zd", i);
2796 goto error;
2797 }
2798 buf[j++] = (top << 4) + bot;
2799 }
2800 if (j != byteslen && _PyBytes_Resize(&newstring, j) < 0)
2801 goto error;
2802 return newstring;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002803
2804 error:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002805 Py_XDECREF(newstring);
2806 return NULL;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002807}
2808
Martin v. Löwis00709aa2008-06-04 14:18:43 +00002809PyDoc_STRVAR(sizeof__doc__,
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002810"B.__sizeof__() -> size of B in memory, in bytes");
Martin v. Löwis00709aa2008-06-04 14:18:43 +00002811
2812static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002813bytes_sizeof(PyBytesObject *v)
Martin v. Löwis00709aa2008-06-04 14:18:43 +00002814{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002815 Py_ssize_t res;
2816 res = PyBytesObject_SIZE + Py_SIZE(v) * Py_TYPE(v)->tp_itemsize;
2817 return PyLong_FromSsize_t(res);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00002818}
2819
Guido van Rossum0dd32e22007-04-11 05:40:58 +00002820
2821static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002822bytes_getnewargs(PyBytesObject *v)
Guido van Rossum0dd32e22007-04-11 05:40:58 +00002823{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002824 return Py_BuildValue("(s#)", v->ob_sval, Py_SIZE(v));
Guido van Rossum0dd32e22007-04-11 05:40:58 +00002825}
2826
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002827
2828static PyMethodDef
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002829bytes_methods[] = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002830 {"__getnewargs__", (PyCFunction)bytes_getnewargs, METH_NOARGS},
2831 {"capitalize", (PyCFunction)stringlib_capitalize, METH_NOARGS,
2832 _Py_capitalize__doc__},
2833 {"center", (PyCFunction)stringlib_center, METH_VARARGS, center__doc__},
2834 {"count", (PyCFunction)bytes_count, METH_VARARGS, count__doc__},
2835 {"decode", (PyCFunction)bytes_decode, METH_VARARGS, decode__doc__},
2836 {"endswith", (PyCFunction)bytes_endswith, METH_VARARGS,
2837 endswith__doc__},
2838 {"expandtabs", (PyCFunction)stringlib_expandtabs, METH_VARARGS,
2839 expandtabs__doc__},
2840 {"find", (PyCFunction)bytes_find, METH_VARARGS, find__doc__},
2841 {"fromhex", (PyCFunction)bytes_fromhex, METH_VARARGS|METH_CLASS,
2842 fromhex_doc},
2843 {"index", (PyCFunction)bytes_index, METH_VARARGS, index__doc__},
2844 {"isalnum", (PyCFunction)stringlib_isalnum, METH_NOARGS,
2845 _Py_isalnum__doc__},
2846 {"isalpha", (PyCFunction)stringlib_isalpha, METH_NOARGS,
2847 _Py_isalpha__doc__},
2848 {"isdigit", (PyCFunction)stringlib_isdigit, METH_NOARGS,
2849 _Py_isdigit__doc__},
2850 {"islower", (PyCFunction)stringlib_islower, METH_NOARGS,
2851 _Py_islower__doc__},
2852 {"isspace", (PyCFunction)stringlib_isspace, METH_NOARGS,
2853 _Py_isspace__doc__},
2854 {"istitle", (PyCFunction)stringlib_istitle, METH_NOARGS,
2855 _Py_istitle__doc__},
2856 {"isupper", (PyCFunction)stringlib_isupper, METH_NOARGS,
2857 _Py_isupper__doc__},
2858 {"join", (PyCFunction)bytes_join, METH_O, join__doc__},
2859 {"ljust", (PyCFunction)stringlib_ljust, METH_VARARGS, ljust__doc__},
2860 {"lower", (PyCFunction)stringlib_lower, METH_NOARGS, _Py_lower__doc__},
2861 {"lstrip", (PyCFunction)bytes_lstrip, METH_VARARGS, lstrip__doc__},
2862 {"maketrans", (PyCFunction)bytes_maketrans, METH_VARARGS|METH_STATIC,
2863 _Py_maketrans__doc__},
2864 {"partition", (PyCFunction)bytes_partition, METH_O, partition__doc__},
2865 {"replace", (PyCFunction)bytes_replace, METH_VARARGS, replace__doc__},
2866 {"rfind", (PyCFunction)bytes_rfind, METH_VARARGS, rfind__doc__},
2867 {"rindex", (PyCFunction)bytes_rindex, METH_VARARGS, rindex__doc__},
2868 {"rjust", (PyCFunction)stringlib_rjust, METH_VARARGS, rjust__doc__},
2869 {"rpartition", (PyCFunction)bytes_rpartition, METH_O,
2870 rpartition__doc__},
2871 {"rsplit", (PyCFunction)bytes_rsplit, METH_VARARGS, rsplit__doc__},
2872 {"rstrip", (PyCFunction)bytes_rstrip, METH_VARARGS, rstrip__doc__},
2873 {"split", (PyCFunction)bytes_split, METH_VARARGS, split__doc__},
2874 {"splitlines", (PyCFunction)stringlib_splitlines, METH_VARARGS,
2875 splitlines__doc__},
2876 {"startswith", (PyCFunction)bytes_startswith, METH_VARARGS,
2877 startswith__doc__},
2878 {"strip", (PyCFunction)bytes_strip, METH_VARARGS, strip__doc__},
2879 {"swapcase", (PyCFunction)stringlib_swapcase, METH_NOARGS,
2880 _Py_swapcase__doc__},
2881 {"title", (PyCFunction)stringlib_title, METH_NOARGS, _Py_title__doc__},
2882 {"translate", (PyCFunction)bytes_translate, METH_VARARGS,
2883 translate__doc__},
2884 {"upper", (PyCFunction)stringlib_upper, METH_NOARGS, _Py_upper__doc__},
2885 {"zfill", (PyCFunction)stringlib_zfill, METH_VARARGS, zfill__doc__},
2886 {"__sizeof__", (PyCFunction)bytes_sizeof, METH_NOARGS,
2887 sizeof__doc__},
2888 {NULL, NULL} /* sentinel */
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002889};
2890
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002891static PyObject *
2892str_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
2893
2894static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002895bytes_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002896{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002897 PyObject *x = NULL;
2898 const char *encoding = NULL;
2899 const char *errors = NULL;
2900 PyObject *new = NULL;
2901 static char *kwlist[] = {"source", "encoding", "errors", 0};
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002902
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002903 if (type != &PyBytes_Type)
2904 return str_subtype_new(type, args, kwds);
2905 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oss:bytes", kwlist, &x,
2906 &encoding, &errors))
2907 return NULL;
2908 if (x == NULL) {
2909 if (encoding != NULL || errors != NULL) {
2910 PyErr_SetString(PyExc_TypeError,
2911 "encoding or errors without sequence "
2912 "argument");
2913 return NULL;
2914 }
2915 return PyBytes_FromString("");
2916 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002917
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002918 if (PyUnicode_Check(x)) {
2919 /* Encode via the codec registry */
2920 if (encoding == NULL) {
2921 PyErr_SetString(PyExc_TypeError,
2922 "string argument without an encoding");
2923 return NULL;
2924 }
2925 new = PyUnicode_AsEncodedString(x, encoding, errors);
2926 if (new == NULL)
2927 return NULL;
2928 assert(PyBytes_Check(new));
2929 return new;
2930 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002931
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002932 /* If it's not unicode, there can't be encoding or errors */
2933 if (encoding != NULL || errors != NULL) {
2934 PyErr_SetString(PyExc_TypeError,
2935 "encoding or errors without a string argument");
2936 return NULL;
2937 }
2938 return PyObject_Bytes(x);
Benjamin Petersonc15a0732008-08-26 16:46:47 +00002939}
2940
2941PyObject *
2942PyBytes_FromObject(PyObject *x)
2943{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002944 PyObject *new, *it;
2945 Py_ssize_t i, size;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002946
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002947 if (x == NULL) {
2948 PyErr_BadInternalCall();
2949 return NULL;
2950 }
Benjamin Peterson4b24a422008-08-27 00:28:34 +00002951
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002952 /* Is it an int? */
2953 size = PyNumber_AsSsize_t(x, PyExc_OverflowError);
2954 if (size == -1 && PyErr_Occurred()) {
2955 if (PyErr_ExceptionMatches(PyExc_OverflowError))
2956 return NULL;
2957 PyErr_Clear();
2958 }
2959 else if (size < 0) {
2960 PyErr_SetString(PyExc_ValueError, "negative count");
2961 return NULL;
2962 }
2963 else {
2964 new = PyBytes_FromStringAndSize(NULL, size);
2965 if (new == NULL) {
2966 return NULL;
2967 }
2968 if (size > 0) {
2969 memset(((PyBytesObject*)new)->ob_sval, 0, size);
2970 }
2971 return new;
2972 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002973
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002974 /* Use the modern buffer interface */
2975 if (PyObject_CheckBuffer(x)) {
2976 Py_buffer view;
2977 if (PyObject_GetBuffer(x, &view, PyBUF_FULL_RO) < 0)
2978 return NULL;
2979 new = PyBytes_FromStringAndSize(NULL, view.len);
2980 if (!new)
2981 goto fail;
2982 /* XXX(brett.cannon): Better way to get to internal buffer? */
2983 if (PyBuffer_ToContiguous(((PyBytesObject *)new)->ob_sval,
2984 &view, view.len, 'C') < 0)
2985 goto fail;
2986 PyBuffer_Release(&view);
2987 return new;
2988 fail:
2989 Py_XDECREF(new);
2990 PyBuffer_Release(&view);
2991 return NULL;
2992 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002993
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002994 /* For iterator version, create a string object and resize as needed */
2995 /* XXX(gb): is 64 a good value? also, optimize if length is known */
2996 /* XXX(guido): perhaps use Pysequence_Fast() -- I can't imagine the
2997 input being a truly long iterator. */
2998 size = 64;
2999 new = PyBytes_FromStringAndSize(NULL, size);
3000 if (new == NULL)
3001 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003002
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003003 /* XXX Optimize this if the arguments is a list, tuple */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003004
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003005 /* Get the iterator */
3006 it = PyObject_GetIter(x);
3007 if (it == NULL)
3008 goto error;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003009
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003010 /* Run the iterator to exhaustion */
3011 for (i = 0; ; i++) {
3012 PyObject *item;
3013 Py_ssize_t value;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003014
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003015 /* Get the next item */
3016 item = PyIter_Next(it);
3017 if (item == NULL) {
3018 if (PyErr_Occurred())
3019 goto error;
3020 break;
3021 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003022
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003023 /* Interpret it as an int (__index__) */
3024 value = PyNumber_AsSsize_t(item, PyExc_ValueError);
3025 Py_DECREF(item);
3026 if (value == -1 && PyErr_Occurred())
3027 goto error;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003028
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003029 /* Range check */
3030 if (value < 0 || value >= 256) {
3031 PyErr_SetString(PyExc_ValueError,
3032 "bytes must be in range(0, 256)");
3033 goto error;
3034 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003035
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003036 /* Append the byte */
3037 if (i >= size) {
3038 size *= 2;
3039 if (_PyBytes_Resize(&new, size) < 0)
3040 goto error;
3041 }
3042 ((PyBytesObject *)new)->ob_sval[i] = value;
3043 }
3044 _PyBytes_Resize(&new, i);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003045
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003046 /* Clean up and return success */
3047 Py_DECREF(it);
3048 return new;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003049
3050 error:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003051 /* Error handling when new != NULL */
3052 Py_XDECREF(it);
3053 Py_DECREF(new);
3054 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003055}
3056
3057static PyObject *
3058str_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3059{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003060 PyObject *tmp, *pnew;
3061 Py_ssize_t n;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003062
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003063 assert(PyType_IsSubtype(type, &PyBytes_Type));
3064 tmp = bytes_new(&PyBytes_Type, args, kwds);
3065 if (tmp == NULL)
3066 return NULL;
3067 assert(PyBytes_CheckExact(tmp));
3068 n = PyBytes_GET_SIZE(tmp);
3069 pnew = type->tp_alloc(type, n);
3070 if (pnew != NULL) {
3071 Py_MEMCPY(PyBytes_AS_STRING(pnew),
3072 PyBytes_AS_STRING(tmp), n+1);
3073 ((PyBytesObject *)pnew)->ob_shash =
3074 ((PyBytesObject *)tmp)->ob_shash;
3075 }
3076 Py_DECREF(tmp);
3077 return pnew;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003078}
3079
Benjamin Peterson80688ef2009-04-18 15:17:02 +00003080PyDoc_STRVAR(bytes_doc,
Georg Brandl17cb8a82008-05-30 08:20:09 +00003081"bytes(iterable_of_ints) -> bytes\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003082bytes(string, encoding[, errors]) -> bytes\n\
Georg Brandl17cb8a82008-05-30 08:20:09 +00003083bytes(bytes_or_buffer) -> immutable copy of bytes_or_buffer\n\
3084bytes(memory_view) -> bytes\n\
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00003085\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003086Construct an immutable array of bytes from:\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00003087 - an iterable yielding integers in range(256)\n\
3088 - a text string encoded using the specified encoding\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003089 - a bytes or a buffer object\n\
3090 - any object implementing the buffer API.");
Guido van Rossum98297ee2007-11-06 21:34:58 +00003091
Benjamin Peterson80688ef2009-04-18 15:17:02 +00003092static PyObject *bytes_iter(PyObject *seq);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00003093
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003094PyTypeObject PyBytes_Type = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003095 PyVarObject_HEAD_INIT(&PyType_Type, 0)
3096 "bytes",
3097 PyBytesObject_SIZE,
3098 sizeof(char),
3099 bytes_dealloc, /* tp_dealloc */
3100 0, /* tp_print */
3101 0, /* tp_getattr */
3102 0, /* tp_setattr */
3103 0, /* tp_reserved */
3104 (reprfunc)bytes_repr, /* tp_repr */
3105 0, /* tp_as_number */
3106 &bytes_as_sequence, /* tp_as_sequence */
3107 &bytes_as_mapping, /* tp_as_mapping */
3108 (hashfunc)bytes_hash, /* tp_hash */
3109 0, /* tp_call */
3110 bytes_str, /* tp_str */
3111 PyObject_GenericGetAttr, /* tp_getattro */
3112 0, /* tp_setattro */
3113 &bytes_as_buffer, /* tp_as_buffer */
3114 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
3115 Py_TPFLAGS_BYTES_SUBCLASS, /* tp_flags */
3116 bytes_doc, /* tp_doc */
3117 0, /* tp_traverse */
3118 0, /* tp_clear */
3119 (richcmpfunc)bytes_richcompare, /* tp_richcompare */
3120 0, /* tp_weaklistoffset */
3121 bytes_iter, /* tp_iter */
3122 0, /* tp_iternext */
3123 bytes_methods, /* tp_methods */
3124 0, /* tp_members */
3125 0, /* tp_getset */
3126 &PyBaseObject_Type, /* tp_base */
3127 0, /* tp_dict */
3128 0, /* tp_descr_get */
3129 0, /* tp_descr_set */
3130 0, /* tp_dictoffset */
3131 0, /* tp_init */
3132 0, /* tp_alloc */
3133 bytes_new, /* tp_new */
3134 PyObject_Del, /* tp_free */
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00003135};
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003136
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003137void
3138PyBytes_Concat(register PyObject **pv, register PyObject *w)
3139{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003140 register PyObject *v;
3141 assert(pv != NULL);
3142 if (*pv == NULL)
3143 return;
3144 if (w == NULL) {
3145 Py_DECREF(*pv);
3146 *pv = NULL;
3147 return;
3148 }
3149 v = bytes_concat(*pv, w);
3150 Py_DECREF(*pv);
3151 *pv = v;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003152}
3153
3154void
3155PyBytes_ConcatAndDel(register PyObject **pv, register PyObject *w)
3156{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003157 PyBytes_Concat(pv, w);
3158 Py_XDECREF(w);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003159}
3160
3161
3162/* The following function breaks the notion that strings are immutable:
3163 it changes the size of a string. We get away with this only if there
3164 is only one module referencing the object. You can also think of it
3165 as creating a new string object and destroying the old one, only
3166 more efficiently. In any case, don't use this if the string may
3167 already be known to some other part of the code...
3168 Note that if there's not enough memory to resize the string, the original
3169 string object at *pv is deallocated, *pv is set to NULL, an "out of
3170 memory" exception is set, and -1 is returned. Else (on success) 0 is
3171 returned, and the value in *pv may or may not be the same as on input.
3172 As always, an extra byte is allocated for a trailing \0 byte (newsize
3173 does *not* include that), and a trailing \0 byte is stored.
3174*/
3175
3176int
3177_PyBytes_Resize(PyObject **pv, Py_ssize_t newsize)
3178{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003179 register PyObject *v;
3180 register PyBytesObject *sv;
3181 v = *pv;
3182 if (!PyBytes_Check(v) || Py_REFCNT(v) != 1 || newsize < 0) {
3183 *pv = 0;
3184 Py_DECREF(v);
3185 PyErr_BadInternalCall();
3186 return -1;
3187 }
3188 /* XXX UNREF/NEWREF interface should be more symmetrical */
3189 _Py_DEC_REFTOTAL;
3190 _Py_ForgetReference(v);
3191 *pv = (PyObject *)
3192 PyObject_REALLOC((char *)v, PyBytesObject_SIZE + newsize);
3193 if (*pv == NULL) {
3194 PyObject_Del(v);
3195 PyErr_NoMemory();
3196 return -1;
3197 }
3198 _Py_NewReference(*pv);
3199 sv = (PyBytesObject *) *pv;
3200 Py_SIZE(sv) = newsize;
3201 sv->ob_sval[newsize] = '\0';
3202 sv->ob_shash = -1; /* invalidate cached hash value */
3203 return 0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003204}
3205
3206/* _PyBytes_FormatLong emulates the format codes d, u, o, x and X, and
3207 * the F_ALT flag, for Python's long (unbounded) ints. It's not used for
3208 * Python's regular ints.
3209 * Return value: a new PyString*, or NULL if error.
3210 * . *pbuf is set to point into it,
3211 * *plen set to the # of chars following that.
3212 * Caller must decref it when done using pbuf.
3213 * The string starting at *pbuf is of the form
3214 * "-"? ("0x" | "0X")? digit+
3215 * "0x"/"0X" are present only for x and X conversions, with F_ALT
3216 * set in flags. The case of hex digits will be correct,
3217 * There will be at least prec digits, zero-filled on the left if
3218 * necessary to get that many.
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003219 * val object to be converted
3220 * flags bitmask of format flags; only F_ALT is looked at
3221 * prec minimum number of digits; 0-fill on left if needed
3222 * type a character in [duoxX]; u acts the same as d
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003223 *
3224 * CAUTION: o, x and X conversions on regular ints can never
3225 * produce a '-' sign, but can for Python's unbounded ints.
3226 */
3227PyObject*
3228_PyBytes_FormatLong(PyObject *val, int flags, int prec, int type,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003229 char **pbuf, int *plen)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003230{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003231 PyObject *result = NULL;
3232 char *buf;
3233 Py_ssize_t i;
3234 int sign; /* 1 if '-', else 0 */
3235 int len; /* number of characters */
3236 Py_ssize_t llen;
3237 int numdigits; /* len == numnondigits + numdigits */
3238 int numnondigits = 0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003239
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003240 /* Avoid exceeding SSIZE_T_MAX */
3241 if (prec > INT_MAX-3) {
3242 PyErr_SetString(PyExc_OverflowError,
3243 "precision too large");
3244 return NULL;
3245 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003246
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003247 switch (type) {
3248 case 'd':
3249 case 'u':
3250 /* Special-case boolean: we want 0/1 */
3251 if (PyBool_Check(val))
3252 result = PyNumber_ToBase(val, 10);
3253 else
3254 result = Py_TYPE(val)->tp_str(val);
3255 break;
3256 case 'o':
3257 numnondigits = 2;
3258 result = PyNumber_ToBase(val, 8);
3259 break;
3260 case 'x':
3261 case 'X':
3262 numnondigits = 2;
3263 result = PyNumber_ToBase(val, 16);
3264 break;
3265 default:
3266 assert(!"'type' not in [duoxX]");
3267 }
3268 if (!result)
3269 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003270
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003271 buf = _PyUnicode_AsString(result);
3272 if (!buf) {
3273 Py_DECREF(result);
3274 return NULL;
3275 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003276
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003277 /* To modify the string in-place, there can only be one reference. */
3278 if (Py_REFCNT(result) != 1) {
3279 PyErr_BadInternalCall();
3280 return NULL;
3281 }
3282 llen = PyUnicode_GetSize(result);
3283 if (llen > INT_MAX) {
3284 PyErr_SetString(PyExc_ValueError,
3285 "string too large in _PyBytes_FormatLong");
3286 return NULL;
3287 }
3288 len = (int)llen;
3289 if (buf[len-1] == 'L') {
3290 --len;
3291 buf[len] = '\0';
3292 }
3293 sign = buf[0] == '-';
3294 numnondigits += sign;
3295 numdigits = len - numnondigits;
3296 assert(numdigits > 0);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003297
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003298 /* Get rid of base marker unless F_ALT */
3299 if (((flags & F_ALT) == 0 &&
3300 (type == 'o' || type == 'x' || type == 'X'))) {
3301 assert(buf[sign] == '0');
3302 assert(buf[sign+1] == 'x' || buf[sign+1] == 'X' ||
3303 buf[sign+1] == 'o');
3304 numnondigits -= 2;
3305 buf += 2;
3306 len -= 2;
3307 if (sign)
3308 buf[0] = '-';
3309 assert(len == numnondigits + numdigits);
3310 assert(numdigits > 0);
3311 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003312
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003313 /* Fill with leading zeroes to meet minimum width. */
3314 if (prec > numdigits) {
3315 PyObject *r1 = PyBytes_FromStringAndSize(NULL,
3316 numnondigits + prec);
3317 char *b1;
3318 if (!r1) {
3319 Py_DECREF(result);
3320 return NULL;
3321 }
3322 b1 = PyBytes_AS_STRING(r1);
3323 for (i = 0; i < numnondigits; ++i)
3324 *b1++ = *buf++;
3325 for (i = 0; i < prec - numdigits; i++)
3326 *b1++ = '0';
3327 for (i = 0; i < numdigits; i++)
3328 *b1++ = *buf++;
3329 *b1 = '\0';
3330 Py_DECREF(result);
3331 result = r1;
3332 buf = PyBytes_AS_STRING(result);
3333 len = numnondigits + prec;
3334 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003335
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003336 /* Fix up case for hex conversions. */
3337 if (type == 'X') {
3338 /* Need to convert all lower case letters to upper case.
3339 and need to convert 0x to 0X (and -0x to -0X). */
3340 for (i = 0; i < len; i++)
3341 if (buf[i] >= 'a' && buf[i] <= 'x')
3342 buf[i] -= 'a'-'A';
3343 }
3344 *pbuf = buf;
3345 *plen = len;
3346 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003347}
3348
3349void
3350PyBytes_Fini(void)
3351{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003352 int i;
3353 for (i = 0; i < UCHAR_MAX + 1; i++) {
3354 Py_XDECREF(characters[i]);
3355 characters[i] = NULL;
3356 }
3357 Py_XDECREF(nullstring);
3358 nullstring = NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003359}
3360
Benjamin Peterson4116f362008-05-27 00:36:20 +00003361/*********************** Bytes Iterator ****************************/
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003362
3363typedef struct {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003364 PyObject_HEAD
3365 Py_ssize_t it_index;
3366 PyBytesObject *it_seq; /* Set to NULL when iterator is exhausted */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003367} striterobject;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003368
3369static void
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003370striter_dealloc(striterobject *it)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003371{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003372 _PyObject_GC_UNTRACK(it);
3373 Py_XDECREF(it->it_seq);
3374 PyObject_GC_Del(it);
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003375}
3376
3377static int
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003378striter_traverse(striterobject *it, visitproc visit, void *arg)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003379{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003380 Py_VISIT(it->it_seq);
3381 return 0;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003382}
3383
3384static PyObject *
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003385striter_next(striterobject *it)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003386{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003387 PyBytesObject *seq;
3388 PyObject *item;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003389
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003390 assert(it != NULL);
3391 seq = it->it_seq;
3392 if (seq == NULL)
3393 return NULL;
3394 assert(PyBytes_Check(seq));
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003395
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003396 if (it->it_index < PyBytes_GET_SIZE(seq)) {
3397 item = PyLong_FromLong(
3398 (unsigned char)seq->ob_sval[it->it_index]);
3399 if (item != NULL)
3400 ++it->it_index;
3401 return item;
3402 }
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003403
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003404 Py_DECREF(seq);
3405 it->it_seq = NULL;
3406 return NULL;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003407}
3408
3409static PyObject *
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003410striter_len(striterobject *it)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003411{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003412 Py_ssize_t len = 0;
3413 if (it->it_seq)
3414 len = PyBytes_GET_SIZE(it->it_seq) - it->it_index;
3415 return PyLong_FromSsize_t(len);
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003416}
3417
3418PyDoc_STRVAR(length_hint_doc,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003419 "Private method returning an estimate of len(list(it)).");
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003420
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003421static PyMethodDef striter_methods[] = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003422 {"__length_hint__", (PyCFunction)striter_len, METH_NOARGS,
3423 length_hint_doc},
3424 {NULL, NULL} /* sentinel */
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003425};
3426
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003427PyTypeObject PyBytesIter_Type = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003428 PyVarObject_HEAD_INIT(&PyType_Type, 0)
3429 "bytes_iterator", /* tp_name */
3430 sizeof(striterobject), /* tp_basicsize */
3431 0, /* tp_itemsize */
3432 /* methods */
3433 (destructor)striter_dealloc, /* tp_dealloc */
3434 0, /* tp_print */
3435 0, /* tp_getattr */
3436 0, /* tp_setattr */
3437 0, /* tp_reserved */
3438 0, /* tp_repr */
3439 0, /* tp_as_number */
3440 0, /* tp_as_sequence */
3441 0, /* tp_as_mapping */
3442 0, /* tp_hash */
3443 0, /* tp_call */
3444 0, /* tp_str */
3445 PyObject_GenericGetAttr, /* tp_getattro */
3446 0, /* tp_setattro */
3447 0, /* tp_as_buffer */
3448 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
3449 0, /* tp_doc */
3450 (traverseproc)striter_traverse, /* tp_traverse */
3451 0, /* tp_clear */
3452 0, /* tp_richcompare */
3453 0, /* tp_weaklistoffset */
3454 PyObject_SelfIter, /* tp_iter */
3455 (iternextfunc)striter_next, /* tp_iternext */
3456 striter_methods, /* tp_methods */
3457 0,
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003458};
3459
3460static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00003461bytes_iter(PyObject *seq)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003462{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003463 striterobject *it;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003464
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003465 if (!PyBytes_Check(seq)) {
3466 PyErr_BadInternalCall();
3467 return NULL;
3468 }
3469 it = PyObject_GC_New(striterobject, &PyBytesIter_Type);
3470 if (it == NULL)
3471 return NULL;
3472 it->it_index = 0;
3473 Py_INCREF(seq);
3474 it->it_seq = (PyBytesObject *)seq;
3475 _PyObject_GC_TRACK(it);
3476 return (PyObject *)it;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003477}