blob: 02351ed6fa0f8dcd73a0fb71e4079a7b5a599458 [file] [log] [blame]
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001
2/* New getargs implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00005
Guido van Rossumc1d50531996-08-21 23:38:24 +00006#include <ctype.h>
7
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00008
Anthony Baxter97300382006-04-12 04:38:54 +00009#ifdef __cplusplus
Antoine Pitrouc83ea132010-05-09 14:46:46 +000010extern "C" {
Anthony Baxter97300382006-04-12 04:38:54 +000011#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000012int PyArg_Parse(PyObject *, const char *, ...);
13int PyArg_ParseTuple(PyObject *, const char *, ...);
14int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000015
Tim Petersdbd9ba62000-07-09 03:09:57 +000016int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouc83ea132010-05-09 14:46:46 +000017 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000018int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouc83ea132010-05-09 14:46:46 +000019 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000020
Martin v. Löwis5cb69362006-04-14 09:08:42 +000021#ifdef HAVE_DECLSPEC_DLL
22/* Export functions */
23PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, char *, ...);
24PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, char *, ...);
25PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
26 const char *, char **, ...);
27PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
28PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, char *, va_list);
29PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
30 const char *, char **, va_list);
31#endif
32
Martin v. Löwis18e16552006-02-15 17:27:45 +000033#define FLAG_COMPAT 1
34#define FLAG_SIZE_T 2
35
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000036
37/* Forward */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000038static int vgetargs1(PyObject *, const char *, va_list *, int);
39static void seterror(int, const char *, int *, const char *, const char *);
Antoine Pitrouc83ea132010-05-09 14:46:46 +000040static char *convertitem(PyObject *, const char **, va_list *, int, int *,
Martin v. Löwis18e16552006-02-15 17:27:45 +000041 char *, size_t, PyObject **);
42static char *converttuple(PyObject *, const char **, va_list *, int,
Antoine Pitrouc83ea132010-05-09 14:46:46 +000043 int *, char *, size_t, int, PyObject **);
Martin v. Löwis18e16552006-02-15 17:27:45 +000044static char *convertsimple(PyObject *, const char **, va_list *, int, char *,
Antoine Pitrouc83ea132010-05-09 14:46:46 +000045 size_t, PyObject **);
Martin v. Löwis18e16552006-02-15 17:27:45 +000046static Py_ssize_t convertbuffer(PyObject *, void **p, char **);
Martin v. Löwisf91d46a2008-08-12 14:49:50 +000047static int getbuffer(PyObject *, Py_buffer *, char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000048
Tim Petersdbd9ba62000-07-09 03:09:57 +000049static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouc83ea132010-05-09 14:46:46 +000050 const char *, char **, va_list *, int);
Martin v. Löwis18e16552006-02-15 17:27:45 +000051static char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000052
Fred Drake563dfc22001-10-23 14:41:08 +000053int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000054PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000055{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000056 int retval;
57 va_list va;
58
59 va_start(va, format);
60 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
61 va_end(va);
62 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +000063}
64
65int
66_PyArg_Parse_SizeT(PyObject *args, char *format, ...)
67{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000068 int retval;
69 va_list va;
70
71 va_start(va, format);
72 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
73 va_end(va);
74 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000075}
76
77
Fred Drake563dfc22001-10-23 14:41:08 +000078int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000079PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000080{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000081 int retval;
82 va_list va;
83
84 va_start(va, format);
85 retval = vgetargs1(args, format, &va, 0);
86 va_end(va);
87 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000088}
89
Martin v. Löwis18e16552006-02-15 17:27:45 +000090int
91_PyArg_ParseTuple_SizeT(PyObject *args, char *format, ...)
92{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000093 int retval;
94 va_list va;
95
96 va_start(va, format);
97 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
98 va_end(va);
99 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000100}
101
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000102
103int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000104PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000105{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000106 va_list lva;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000107
108#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000109 memcpy(lva, va, sizeof(va_list));
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000110#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000111#ifdef __va_copy
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000112 __va_copy(lva, va);
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000113#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000114 lva = va;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000115#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000116#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000117
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000118 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000119}
120
Martin v. Löwis18e16552006-02-15 17:27:45 +0000121int
122_PyArg_VaParse_SizeT(PyObject *args, char *format, va_list va)
123{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000124 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000125
126#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000127 memcpy(lva, va, sizeof(va_list));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000128#else
129#ifdef __va_copy
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000130 __va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000131#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000132 lva = va;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000133#endif
134#endif
135
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000136 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000137}
138
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000139
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000140/* Handle cleanup of allocated memory in case of exception */
141
Larry Hastings402b73f2010-03-25 00:54:54 +0000142#define GETARGS_CAPSULE_NAME_CLEANUP_PTR "getargs.cleanup_ptr"
143#define GETARGS_CAPSULE_NAME_CLEANUP_BUFFER "getargs.cleanup_buffer"
144
Antoine Pitroud4ae97b2008-08-29 18:39:48 +0000145static void
Larry Hastings402b73f2010-03-25 00:54:54 +0000146cleanup_ptr(PyObject *self)
Antoine Pitroud4ae97b2008-08-29 18:39:48 +0000147{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000148 void *ptr = PyCapsule_GetPointer(self, GETARGS_CAPSULE_NAME_CLEANUP_PTR);
149 if (ptr) {
150 PyMem_FREE(ptr);
151 }
Antoine Pitroud4ae97b2008-08-29 18:39:48 +0000152}
153
154static void
Larry Hastings402b73f2010-03-25 00:54:54 +0000155cleanup_buffer(PyObject *self)
Antoine Pitroud4ae97b2008-08-29 18:39:48 +0000156{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000157 Py_buffer *ptr = (Py_buffer *)PyCapsule_GetPointer(self, GETARGS_CAPSULE_NAME_CLEANUP_BUFFER);
158 if (ptr) {
159 PyBuffer_Release(ptr);
160 }
Antoine Pitroud4ae97b2008-08-29 18:39:48 +0000161}
162
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000163static int
Larry Hastings402b73f2010-03-25 00:54:54 +0000164addcleanup(void *ptr, PyObject **freelist, PyCapsule_Destructor destr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000165{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000166 PyObject *cobj;
167 const char *name;
Larry Hastings402b73f2010-03-25 00:54:54 +0000168
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000169 if (!*freelist) {
170 *freelist = PyList_New(0);
171 if (!*freelist) {
172 destr(ptr);
173 return -1;
174 }
175 }
Larry Hastings402b73f2010-03-25 00:54:54 +0000176
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000177 if (destr == cleanup_ptr) {
178 name = GETARGS_CAPSULE_NAME_CLEANUP_PTR;
179 } else if (destr == cleanup_buffer) {
180 name = GETARGS_CAPSULE_NAME_CLEANUP_BUFFER;
181 } else {
182 return -1;
183 }
184 cobj = PyCapsule_New(ptr, name, destr);
185 if (!cobj) {
186 destr(ptr);
187 return -1;
188 }
189 if (PyList_Append(*freelist, cobj)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000190 Py_DECREF(cobj);
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000191 return -1;
192 }
193 Py_DECREF(cobj);
194 return 0;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000195}
196
197static int
198cleanreturn(int retval, PyObject *freelist)
199{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000200 if (freelist && retval != 0) {
201 /* We were successful, reset the destructors so that they
202 don't get called. */
203 Py_ssize_t len = PyList_GET_SIZE(freelist), i;
204 for (i = 0; i < len; i++)
205 PyCapsule_SetDestructor(PyList_GET_ITEM(freelist, i), NULL);
206 }
207 Py_XDECREF(freelist);
208 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000209}
210
211
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000212static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000213vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000214{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000215 char msgbuf[256];
216 int levels[32];
217 const char *fname = NULL;
218 const char *message = NULL;
219 int min = -1;
220 int max = 0;
221 int level = 0;
222 int endfmt = 0;
223 const char *formatsave = format;
224 Py_ssize_t i, len;
225 char *msg;
226 PyObject *freelist = NULL;
227 int compat = flags & FLAG_COMPAT;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000228
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000229 assert(compat || (args != (PyObject*)NULL));
230 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000231
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000232 while (endfmt == 0) {
233 int c = *format++;
234 switch (c) {
235 case '(':
236 if (level == 0)
237 max++;
238 level++;
239 if (level >= 30)
240 Py_FatalError("too many tuple nesting levels "
241 "in argument format string");
242 break;
243 case ')':
244 if (level == 0)
245 Py_FatalError("excess ')' in getargs format");
246 else
247 level--;
248 break;
249 case '\0':
250 endfmt = 1;
251 break;
252 case ':':
253 fname = format;
254 endfmt = 1;
255 break;
256 case ';':
257 message = format;
258 endfmt = 1;
259 break;
260 default:
261 if (level == 0) {
262 if (c == 'O')
263 max++;
264 else if (isalpha(Py_CHARMASK(c))) {
265 if (c != 'e') /* skip encoded */
266 max++;
267 } else if (c == '|')
268 min = max;
269 }
270 break;
271 }
272 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000273
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000274 if (level != 0)
275 Py_FatalError(/* '(' */ "missing ')' in getargs format");
276
277 if (min < 0)
278 min = max;
279
280 format = formatsave;
281
282 if (compat) {
283 if (max == 0) {
284 if (args == NULL)
285 return 1;
286 PyOS_snprintf(msgbuf, sizeof(msgbuf),
287 "%.200s%s takes no arguments",
288 fname==NULL ? "function" : fname,
289 fname==NULL ? "" : "()");
290 PyErr_SetString(PyExc_TypeError, msgbuf);
291 return 0;
292 }
293 else if (min == 1 && max == 1) {
294 if (args == NULL) {
295 PyOS_snprintf(msgbuf, sizeof(msgbuf),
296 "%.200s%s takes at least one argument",
297 fname==NULL ? "function" : fname,
298 fname==NULL ? "" : "()");
299 PyErr_SetString(PyExc_TypeError, msgbuf);
300 return 0;
301 }
302 msg = convertitem(args, &format, p_va, flags, levels,
303 msgbuf, sizeof(msgbuf), &freelist);
304 if (msg == NULL)
305 return cleanreturn(1, freelist);
306 seterror(levels[0], msg, levels+1, fname, message);
307 return cleanreturn(0, freelist);
308 }
309 else {
310 PyErr_SetString(PyExc_SystemError,
311 "old style getargs format uses new features");
312 return 0;
313 }
314 }
315
316 if (!PyTuple_Check(args)) {
317 PyErr_SetString(PyExc_SystemError,
318 "new style getargs format but argument is not a tuple");
319 return 0;
320 }
321
322 len = PyTuple_GET_SIZE(args);
323
324 if (len < min || max < len) {
325 if (message == NULL) {
326 PyOS_snprintf(msgbuf, sizeof(msgbuf),
327 "%.150s%s takes %s %d argument%s "
328 "(%ld given)",
329 fname==NULL ? "function" : fname,
330 fname==NULL ? "" : "()",
331 min==max ? "exactly"
332 : len < min ? "at least" : "at most",
333 len < min ? min : max,
334 (len < min ? min : max) == 1 ? "" : "s",
335 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
336 message = msgbuf;
337 }
338 PyErr_SetString(PyExc_TypeError, message);
339 return 0;
340 }
341
342 for (i = 0; i < len; i++) {
343 if (*format == '|')
344 format++;
345 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
346 flags, levels, msgbuf,
347 sizeof(msgbuf), &freelist);
348 if (msg) {
349 seterror(i+1, msg, levels, fname, msg);
350 return cleanreturn(0, freelist);
351 }
352 }
353
354 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
355 *format != '(' &&
356 *format != '|' && *format != ':' && *format != ';') {
357 PyErr_Format(PyExc_SystemError,
358 "bad format string: %.200s", formatsave);
359 return cleanreturn(0, freelist);
360 }
361
362 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000363}
364
365
366
367static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000368seterror(int iarg, const char *msg, int *levels, const char *fname,
369 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000370{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000371 char buf[512];
372 int i;
373 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000374
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000375 if (PyErr_Occurred())
376 return;
377 else if (message == NULL) {
378 if (fname != NULL) {
379 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
380 p += strlen(p);
381 }
382 if (iarg != 0) {
383 PyOS_snprintf(p, sizeof(buf) - (p - buf),
384 "argument %d", iarg);
385 i = 0;
386 p += strlen(p);
387 while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
388 PyOS_snprintf(p, sizeof(buf) - (p - buf),
389 ", item %d", levels[i]-1);
390 p += strlen(p);
391 i++;
392 }
393 }
394 else {
395 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
396 p += strlen(p);
397 }
398 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
399 message = buf;
400 }
401 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000402}
403
404
405/* Convert a tuple argument.
406 On entry, *p_format points to the character _after_ the opening '('.
407 On successful exit, *p_format points to the closing ')'.
408 If successful:
409 *p_format and *p_va are updated,
410 *levels and *msgbuf are untouched,
411 and NULL is returned.
412 If the argument is invalid:
413 *p_format is unchanged,
414 *p_va is undefined,
415 *levels is a 0-terminated list of item numbers,
416 *msgbuf contains an error message, whose format is:
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000417 "must be <typename1>, not <typename2>", where:
418 <typename1> is the name of the expected type, and
419 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000420 and msgbuf is returned.
421*/
422
423static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000424converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000425 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000426 PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000427{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000428 int level = 0;
429 int n = 0;
430 const char *format = *p_format;
431 int i;
Ka-Ping Yee20579702001-01-15 22:14:16 +0000432
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000433 for (;;) {
434 int c = *format++;
435 if (c == '(') {
436 if (level == 0)
437 n++;
438 level++;
439 }
440 else if (c == ')') {
441 if (level == 0)
442 break;
443 level--;
444 }
445 else if (c == ':' || c == ';' || c == '\0')
446 break;
447 else if (level == 0 && isalpha(Py_CHARMASK(c)))
448 n++;
449 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000450
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000451 if (!PySequence_Check(arg) || PyString_Check(arg)) {
452 levels[0] = 0;
453 PyOS_snprintf(msgbuf, bufsize,
454 toplevel ? "expected %d arguments, not %.50s" :
455 "must be %d-item sequence, not %.50s",
456 n,
457 arg == Py_None ? "None" : arg->ob_type->tp_name);
458 return msgbuf;
459 }
460
461 if ((i = PySequence_Size(arg)) != n) {
462 levels[0] = 0;
463 PyOS_snprintf(msgbuf, bufsize,
464 toplevel ? "expected %d arguments, not %d" :
465 "must be sequence of length %d, not %d",
466 n, i);
467 return msgbuf;
468 }
469
470 format = *p_format;
471 for (i = 0; i < n; i++) {
472 char *msg;
473 PyObject *item;
474 item = PySequence_GetItem(arg, i);
475 if (item == NULL) {
476 PyErr_Clear();
477 levels[0] = i+1;
478 levels[1] = 0;
479 strncpy(msgbuf, "is not retrievable", bufsize);
480 return msgbuf;
481 }
482 msg = convertitem(item, &format, p_va, flags, levels+1,
483 msgbuf, bufsize, freelist);
484 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
485 Py_XDECREF(item);
486 if (msg != NULL) {
487 levels[0] = i+1;
488 return msg;
489 }
490 }
491
492 *p_format = format;
493 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000494}
495
496
497/* Convert a single item. */
498
499static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000500convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
501 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000502{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000503 char *msg;
504 const char *format = *p_format;
505
506 if (*format == '(' /* ')' */) {
507 format++;
508 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
509 bufsize, 0, freelist);
510 if (msg == NULL)
511 format++;
512 }
513 else {
514 msg = convertsimple(arg, &format, p_va, flags,
515 msgbuf, bufsize, freelist);
516 if (msg != NULL)
517 levels[0] = 0;
518 }
519 if (msg == NULL)
520 *p_format = format;
521 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000522}
523
524
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000525
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000526#define UNICODE_DEFAULT_ENCODING(arg) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000527 _PyUnicode_AsDefaultEncodedString(arg, NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000528
529/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000530
531static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000532converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000533{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000534 assert(expected != NULL);
535 assert(arg != NULL);
536 PyOS_snprintf(msgbuf, bufsize,
537 "must be %.50s, not %.50s", expected,
538 arg == Py_None ? "None" : arg->ob_type->tp_name);
539 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000540}
541
542#define CONV_UNICODE "(unicode conversion error)"
543
Neil Schemenauer5042da62003-02-04 20:59:40 +0000544/* explicitly check for float arguments when integers are expected. For now
545 * signal a warning. Returns true if an exception was raised. */
546static int
Mark Dickinson1b34d252010-01-01 17:27:30 +0000547float_argument_warning(PyObject *arg)
Neil Schemenauer5042da62003-02-04 20:59:40 +0000548{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000549 if (PyFloat_Check(arg) &&
550 PyErr_Warn(PyExc_DeprecationWarning,
551 "integer argument expected, got float" ))
552 return 1;
553 else
554 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000555}
556
Mark Dickinson1b34d252010-01-01 17:27:30 +0000557/* explicitly check for float arguments when integers are expected. Raises
558 TypeError and returns true for float arguments. */
559static int
560float_argument_error(PyObject *arg)
561{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000562 if (PyFloat_Check(arg)) {
563 PyErr_SetString(PyExc_TypeError,
564 "integer argument expected, got float");
565 return 1;
566 }
567 else
568 return 0;
Mark Dickinson1b34d252010-01-01 17:27:30 +0000569}
570
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000571/* Convert a non-tuple argument. Return NULL if conversion went OK,
572 or a string with a message describing the failure. The message is
573 formatted as "must be <desired type>, not <actual type>".
574 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000575 Don't call if a tuple is expected.
576
577 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000578*/
579
580static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000581convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000582 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000583{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000584 /* For # codes */
585#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
586 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
587 else q=va_arg(*p_va, int*);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000588#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
589#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
590
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000591 const char *format = *p_format;
592 char c = *format++;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000593#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000594 PyObject *uarg;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000595#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000596
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000597 switch (c) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000598
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000599 case 'b': { /* unsigned byte -- very short int */
600 char *p = va_arg(*p_va, char *);
601 long ival;
602 if (float_argument_error(arg))
603 return converterr("integer<b>", arg, msgbuf, bufsize);
604 ival = PyInt_AsLong(arg);
605 if (ival == -1 && PyErr_Occurred())
606 return converterr("integer<b>", arg, msgbuf, bufsize);
607 else if (ival < 0) {
608 PyErr_SetString(PyExc_OverflowError,
609 "unsigned byte integer is less than minimum");
610 return converterr("integer<b>", arg, msgbuf, bufsize);
611 }
612 else if (ival > UCHAR_MAX) {
613 PyErr_SetString(PyExc_OverflowError,
614 "unsigned byte integer is greater than maximum");
615 return converterr("integer<b>", arg, msgbuf, bufsize);
616 }
617 else
618 *p = (unsigned char) ival;
619 break;
620 }
621
622 case 'B': {/* byte sized bitfield - both signed and unsigned
623 values allowed */
624 char *p = va_arg(*p_va, char *);
625 long ival;
626 if (float_argument_error(arg))
627 return converterr("integer<B>", arg, msgbuf, bufsize);
628 ival = PyInt_AsUnsignedLongMask(arg);
629 if (ival == -1 && PyErr_Occurred())
630 return converterr("integer<B>", arg, msgbuf, bufsize);
631 else
632 *p = (unsigned char) ival;
633 break;
634 }
635
636 case 'h': {/* signed short int */
637 short *p = va_arg(*p_va, short *);
638 long ival;
639 if (float_argument_error(arg))
640 return converterr("integer<h>", arg, msgbuf, bufsize);
641 ival = PyInt_AsLong(arg);
642 if (ival == -1 && PyErr_Occurred())
643 return converterr("integer<h>", arg, msgbuf, bufsize);
644 else if (ival < SHRT_MIN) {
645 PyErr_SetString(PyExc_OverflowError,
646 "signed short integer is less than minimum");
647 return converterr("integer<h>", arg, msgbuf, bufsize);
648 }
649 else if (ival > SHRT_MAX) {
650 PyErr_SetString(PyExc_OverflowError,
651 "signed short integer is greater than maximum");
652 return converterr("integer<h>", arg, msgbuf, bufsize);
653 }
654 else
655 *p = (short) ival;
656 break;
657 }
658
659 case 'H': { /* short int sized bitfield, both signed and
660 unsigned allowed */
661 unsigned short *p = va_arg(*p_va, unsigned short *);
662 long ival;
663 if (float_argument_error(arg))
664 return converterr("integer<H>", arg, msgbuf, bufsize);
665 ival = PyInt_AsUnsignedLongMask(arg);
666 if (ival == -1 && PyErr_Occurred())
667 return converterr("integer<H>", arg, msgbuf, bufsize);
668 else
669 *p = (unsigned short) ival;
670 break;
671 }
672
673 case 'i': {/* signed int */
674 int *p = va_arg(*p_va, int *);
675 long ival;
676 if (float_argument_error(arg))
677 return converterr("integer<i>", arg, msgbuf, bufsize);
678 ival = PyInt_AsLong(arg);
679 if (ival == -1 && PyErr_Occurred())
680 return converterr("integer<i>", arg, msgbuf, bufsize);
681 else if (ival > INT_MAX) {
682 PyErr_SetString(PyExc_OverflowError,
683 "signed integer is greater than maximum");
684 return converterr("integer<i>", arg, msgbuf, bufsize);
685 }
686 else if (ival < INT_MIN) {
687 PyErr_SetString(PyExc_OverflowError,
688 "signed integer is less than minimum");
689 return converterr("integer<i>", arg, msgbuf, bufsize);
690 }
691 else
692 *p = ival;
693 break;
694 }
695
696 case 'I': { /* int sized bitfield, both signed and
697 unsigned allowed */
698 unsigned int *p = va_arg(*p_va, unsigned int *);
699 unsigned int ival;
700 if (float_argument_error(arg))
701 return converterr("integer<I>", arg, msgbuf, bufsize);
702 ival = (unsigned int)PyInt_AsUnsignedLongMask(arg);
703 if (ival == (unsigned int)-1 && PyErr_Occurred())
704 return converterr("integer<I>", arg, msgbuf, bufsize);
705 else
706 *p = ival;
707 break;
708 }
709
710 case 'n': /* Py_ssize_t */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000711#if SIZEOF_SIZE_T != SIZEOF_LONG
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000712 {
713 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
714 Py_ssize_t ival;
715 if (float_argument_error(arg))
716 return converterr("integer<n>", arg, msgbuf, bufsize);
717 ival = PyInt_AsSsize_t(arg);
718 if (ival == -1 && PyErr_Occurred())
719 return converterr("integer<n>", arg, msgbuf, bufsize);
720 *p = ival;
721 break;
722 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000723#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000724 /* Fall through from 'n' to 'l' if Py_ssize_t is int */
725 case 'l': {/* long int */
726 long *p = va_arg(*p_va, long *);
727 long ival;
728 if (float_argument_error(arg))
729 return converterr("integer<l>", arg, msgbuf, bufsize);
730 ival = PyInt_AsLong(arg);
731 if (ival == -1 && PyErr_Occurred())
732 return converterr("integer<l>", arg, msgbuf, bufsize);
733 else
734 *p = ival;
735 break;
736 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000737
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000738 case 'k': { /* long sized bitfield */
739 unsigned long *p = va_arg(*p_va, unsigned long *);
740 unsigned long ival;
741 if (PyInt_Check(arg))
742 ival = PyInt_AsUnsignedLongMask(arg);
743 else if (PyLong_Check(arg))
744 ival = PyLong_AsUnsignedLongMask(arg);
745 else
746 return converterr("integer<k>", arg, msgbuf, bufsize);
747 *p = ival;
748 break;
749 }
750
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000751#ifdef HAVE_LONG_LONG
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000752 case 'L': {/* PY_LONG_LONG */
753 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
754 PY_LONG_LONG ival;
755 if (float_argument_warning(arg))
756 return converterr("long<L>", arg, msgbuf, bufsize);
757 ival = PyLong_AsLongLong(arg);
758 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
759 return converterr("long<L>", arg, msgbuf, bufsize);
760 } else {
761 *p = ival;
762 }
763 break;
764 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000765
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000766 case 'K': { /* long long sized bitfield */
767 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
768 unsigned PY_LONG_LONG ival;
769 if (PyInt_Check(arg))
770 ival = PyInt_AsUnsignedLongMask(arg);
771 else if (PyLong_Check(arg))
772 ival = PyLong_AsUnsignedLongLongMask(arg);
773 else
774 return converterr("integer<K>", arg, msgbuf, bufsize);
775 *p = ival;
776 break;
777 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000778#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000779
780 case 'f': {/* float */
781 float *p = va_arg(*p_va, float *);
782 double dval = PyFloat_AsDouble(arg);
783 if (PyErr_Occurred())
784 return converterr("float<f>", arg, msgbuf, bufsize);
785 else
786 *p = (float) dval;
787 break;
788 }
789
790 case 'd': {/* double */
791 double *p = va_arg(*p_va, double *);
792 double dval = PyFloat_AsDouble(arg);
793 if (PyErr_Occurred())
794 return converterr("float<d>", arg, msgbuf, bufsize);
795 else
796 *p = dval;
797 break;
798 }
799
Guido van Rossum530956d1996-07-21 02:27:43 +0000800#ifndef WITHOUT_COMPLEX
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000801 case 'D': {/* complex double */
802 Py_complex *p = va_arg(*p_va, Py_complex *);
803 Py_complex cval;
804 cval = PyComplex_AsCComplex(arg);
805 if (PyErr_Occurred())
806 return converterr("complex<D>", arg, msgbuf, bufsize);
807 else
808 *p = cval;
809 break;
810 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000811#endif /* WITHOUT_COMPLEX */
Martin v. Löwisf91d46a2008-08-12 14:49:50 +0000812
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000813 case 'c': {/* char */
814 char *p = va_arg(*p_va, char *);
815 if (PyString_Check(arg) && PyString_Size(arg) == 1)
816 *p = PyString_AS_STRING(arg)[0];
817 else
818 return converterr("char", arg, msgbuf, bufsize);
819 break;
820 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000821
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000822 case 's': {/* string */
823 if (*format == '*') {
824 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwisf91d46a2008-08-12 14:49:50 +0000825
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000826 if (PyString_Check(arg)) {
827 PyBuffer_FillInfo(p, arg,
828 PyString_AS_STRING(arg), PyString_GET_SIZE(arg),
829 1, 0);
830 }
Martin v. Löwisf91d46a2008-08-12 14:49:50 +0000831#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000832 else if (PyUnicode_Check(arg)) {
833 uarg = UNICODE_DEFAULT_ENCODING(arg);
834 if (uarg == NULL)
835 return converterr(CONV_UNICODE,
836 arg, msgbuf, bufsize);
837 PyBuffer_FillInfo(p, arg,
838 PyString_AS_STRING(uarg), PyString_GET_SIZE(uarg),
839 1, 0);
840 }
Martin v. Löwisf91d46a2008-08-12 14:49:50 +0000841#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000842 else { /* any buffer-like object */
843 char *buf;
844 if (getbuffer(arg, p, &buf) < 0)
845 return converterr(buf, arg, msgbuf, bufsize);
846 }
847 if (addcleanup(p, freelist, cleanup_buffer)) {
848 return converterr(
849 "(cleanup problem)",
850 arg, msgbuf, bufsize);
851 }
852 format++;
853 } else if (*format == '#') {
854 void **p = (void **)va_arg(*p_va, char **);
855 FETCH_SIZE;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000856
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000857 if (PyString_Check(arg)) {
858 *p = PyString_AS_STRING(arg);
859 STORE_SIZE(PyString_GET_SIZE(arg));
860 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000861#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000862 else if (PyUnicode_Check(arg)) {
863 uarg = UNICODE_DEFAULT_ENCODING(arg);
864 if (uarg == NULL)
865 return converterr(CONV_UNICODE,
866 arg, msgbuf, bufsize);
867 *p = PyString_AS_STRING(uarg);
868 STORE_SIZE(PyString_GET_SIZE(uarg));
869 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000870#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000871 else { /* any buffer-like object */
872 char *buf;
873 Py_ssize_t count = convertbuffer(arg, p, &buf);
874 if (count < 0)
875 return converterr(buf, arg, msgbuf, bufsize);
876 STORE_SIZE(count);
877 }
878 format++;
879 } else {
880 char **p = va_arg(*p_va, char **);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000881
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000882 if (PyString_Check(arg))
883 *p = PyString_AS_STRING(arg);
884#ifdef Py_USING_UNICODE
885 else if (PyUnicode_Check(arg)) {
886 uarg = UNICODE_DEFAULT_ENCODING(arg);
887 if (uarg == NULL)
888 return converterr(CONV_UNICODE,
889 arg, msgbuf, bufsize);
890 *p = PyString_AS_STRING(uarg);
891 }
892#endif
893 else
894 return converterr("string", arg, msgbuf, bufsize);
895 if ((Py_ssize_t)strlen(*p) != PyString_Size(arg))
896 return converterr("string without null bytes",
897 arg, msgbuf, bufsize);
898 }
899 break;
900 }
901
902 case 'z': {/* string, may be NULL (None) */
903 if (*format == '*') {
904 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
905
906 if (arg == Py_None)
907 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
908 else if (PyString_Check(arg)) {
909 PyBuffer_FillInfo(p, arg,
910 PyString_AS_STRING(arg), PyString_GET_SIZE(arg),
911 1, 0);
912 }
913#ifdef Py_USING_UNICODE
914 else if (PyUnicode_Check(arg)) {
915 uarg = UNICODE_DEFAULT_ENCODING(arg);
916 if (uarg == NULL)
917 return converterr(CONV_UNICODE,
918 arg, msgbuf, bufsize);
919 PyBuffer_FillInfo(p, arg,
920 PyString_AS_STRING(uarg), PyString_GET_SIZE(uarg),
921 1, 0);
922 }
923#endif
924 else { /* any buffer-like object */
925 char *buf;
926 if (getbuffer(arg, p, &buf) < 0)
927 return converterr(buf, arg, msgbuf, bufsize);
928 }
929 if (addcleanup(p, freelist, cleanup_buffer)) {
930 return converterr(
931 "(cleanup problem)",
932 arg, msgbuf, bufsize);
933 }
934 format++;
935 } else if (*format == '#') { /* any buffer-like object */
936 void **p = (void **)va_arg(*p_va, char **);
937 FETCH_SIZE;
938
939 if (arg == Py_None) {
940 *p = 0;
941 STORE_SIZE(0);
942 }
943 else if (PyString_Check(arg)) {
944 *p = PyString_AS_STRING(arg);
945 STORE_SIZE(PyString_GET_SIZE(arg));
946 }
947#ifdef Py_USING_UNICODE
948 else if (PyUnicode_Check(arg)) {
949 uarg = UNICODE_DEFAULT_ENCODING(arg);
950 if (uarg == NULL)
951 return converterr(CONV_UNICODE,
952 arg, msgbuf, bufsize);
953 *p = PyString_AS_STRING(uarg);
954 STORE_SIZE(PyString_GET_SIZE(uarg));
955 }
956#endif
957 else { /* any buffer-like object */
958 char *buf;
959 Py_ssize_t count = convertbuffer(arg, p, &buf);
960 if (count < 0)
961 return converterr(buf, arg, msgbuf, bufsize);
962 STORE_SIZE(count);
963 }
964 format++;
965 } else {
966 char **p = va_arg(*p_va, char **);
967
968 if (arg == Py_None)
969 *p = 0;
970 else if (PyString_Check(arg))
971 *p = PyString_AS_STRING(arg);
972#ifdef Py_USING_UNICODE
973 else if (PyUnicode_Check(arg)) {
974 uarg = UNICODE_DEFAULT_ENCODING(arg);
975 if (uarg == NULL)
976 return converterr(CONV_UNICODE,
977 arg, msgbuf, bufsize);
978 *p = PyString_AS_STRING(uarg);
979 }
980#endif
981 else
982 return converterr("string or None",
983 arg, msgbuf, bufsize);
984 if (*format == '#') {
985 FETCH_SIZE;
986 assert(0); /* XXX redundant with if-case */
Victor Stinner645b9f62011-05-03 15:06:11 +0200987 if (arg == Py_None) {
988 STORE_SIZE(0);
989 } else {
990 STORE_SIZE(PyString_Size(arg));
991 }
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000992 format++;
993 }
994 else if (*p != NULL &&
995 (Py_ssize_t)strlen(*p) != PyString_Size(arg))
996 return converterr(
997 "string without null bytes or None",
998 arg, msgbuf, bufsize);
999 }
1000 break;
1001 }
1002
1003 case 'e': {/* encoded string */
1004 char **buffer;
1005 const char *encoding;
1006 PyObject *s;
1007 Py_ssize_t size;
1008 int recode_strings;
1009
1010 /* Get 'e' parameter: the encoding name */
1011 encoding = (const char *)va_arg(*p_va, const char *);
1012#ifdef Py_USING_UNICODE
1013 if (encoding == NULL)
1014 encoding = PyUnicode_GetDefaultEncoding();
1015#endif
1016
1017 /* Get output buffer parameter:
1018 's' (recode all objects via Unicode) or
1019 't' (only recode non-string objects)
1020 */
1021 if (*format == 's')
1022 recode_strings = 1;
1023 else if (*format == 't')
1024 recode_strings = 0;
1025 else
1026 return converterr(
1027 "(unknown parser marker combination)",
1028 arg, msgbuf, bufsize);
1029 buffer = (char **)va_arg(*p_va, char **);
1030 format++;
1031 if (buffer == NULL)
1032 return converterr("(buffer is NULL)",
1033 arg, msgbuf, bufsize);
1034
1035 /* Encode object */
1036 if (!recode_strings && PyString_Check(arg)) {
1037 s = arg;
1038 Py_INCREF(s);
1039 }
1040 else {
1041#ifdef Py_USING_UNICODE
1042 PyObject *u;
1043
1044 /* Convert object to Unicode */
1045 u = PyUnicode_FromObject(arg);
1046 if (u == NULL)
1047 return converterr(
1048 "string or unicode or text buffer",
1049 arg, msgbuf, bufsize);
1050
1051 /* Encode object; use default error handling */
1052 s = PyUnicode_AsEncodedString(u,
1053 encoding,
1054 NULL);
1055 Py_DECREF(u);
1056 if (s == NULL)
1057 return converterr("(encoding failed)",
1058 arg, msgbuf, bufsize);
1059 if (!PyString_Check(s)) {
1060 Py_DECREF(s);
1061 return converterr(
1062 "(encoder failed to return a string)",
1063 arg, msgbuf, bufsize);
1064 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001065#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001066 return converterr("string<e>", arg, msgbuf, bufsize);
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001067#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001068 }
1069 size = PyString_GET_SIZE(s);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001070
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001071 /* Write output; output is guaranteed to be 0-terminated */
1072 if (*format == '#') {
1073 /* Using buffer length parameter '#':
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001074
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001075 - if *buffer is NULL, a new buffer of the
1076 needed size is allocated and the data
1077 copied into it; *buffer is updated to point
1078 to the new buffer; the caller is
1079 responsible for PyMem_Free()ing it after
1080 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001081
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001082 - if *buffer is not NULL, the data is
1083 copied to *buffer; *buffer_len has to be
1084 set to the size of the buffer on input;
1085 buffer overflow is signalled with an error;
1086 buffer has to provide enough room for the
1087 encoded string plus the trailing 0-byte
Fred Drake25871c02000-05-03 15:17:02 +00001088
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001089 - in both cases, *buffer_len is updated to
1090 the size of the buffer /excluding/ the
1091 trailing 0-byte
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001092
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001093 */
1094 FETCH_SIZE;
1095
1096 format++;
1097 if (q == NULL && q2 == NULL) {
1098 Py_DECREF(s);
1099 return converterr(
1100 "(buffer_len is NULL)",
1101 arg, msgbuf, bufsize);
1102 }
1103 if (*buffer == NULL) {
1104 *buffer = PyMem_NEW(char, size + 1);
1105 if (*buffer == NULL) {
1106 Py_DECREF(s);
1107 return converterr(
1108 "(memory error)",
1109 arg, msgbuf, bufsize);
1110 }
1111 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1112 Py_DECREF(s);
1113 return converterr(
1114 "(cleanup problem)",
1115 arg, msgbuf, bufsize);
1116 }
1117 } else {
1118 if (size + 1 > BUFFER_LEN) {
1119 Py_DECREF(s);
1120 return converterr(
1121 "(buffer overflow)",
1122 arg, msgbuf, bufsize);
1123 }
1124 }
1125 memcpy(*buffer,
1126 PyString_AS_STRING(s),
1127 size + 1);
1128 STORE_SIZE(size);
1129 } else {
1130 /* Using a 0-terminated buffer:
1131
1132 - the encoded string has to be 0-terminated
1133 for this variant to work; if it is not, an
1134 error raised
1135
1136 - a new buffer of the needed size is
1137 allocated and the data copied into it;
1138 *buffer is updated to point to the new
1139 buffer; the caller is responsible for
1140 PyMem_Free()ing it after usage
1141
1142 */
1143 if ((Py_ssize_t)strlen(PyString_AS_STRING(s))
1144 != size) {
1145 Py_DECREF(s);
1146 return converterr(
1147 "encoded string without NULL bytes",
1148 arg, msgbuf, bufsize);
1149 }
1150 *buffer = PyMem_NEW(char, size + 1);
1151 if (*buffer == NULL) {
1152 Py_DECREF(s);
1153 return converterr("(memory error)",
1154 arg, msgbuf, bufsize);
1155 }
1156 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1157 Py_DECREF(s);
1158 return converterr("(cleanup problem)",
1159 arg, msgbuf, bufsize);
1160 }
1161 memcpy(*buffer,
1162 PyString_AS_STRING(s),
1163 size + 1);
1164 }
1165 Py_DECREF(s);
1166 break;
1167 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001168
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001169#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001170 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1171 if (*format == '#') { /* any buffer-like object */
1172 void **p = (void **)va_arg(*p_va, char **);
1173 FETCH_SIZE;
1174 if (PyUnicode_Check(arg)) {
1175 *p = PyUnicode_AS_UNICODE(arg);
1176 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1177 }
1178 else {
1179 return converterr("cannot convert raw buffers",
1180 arg, msgbuf, bufsize);
1181 }
1182 format++;
1183 } else {
1184 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1185 if (PyUnicode_Check(arg))
1186 *p = PyUnicode_AS_UNICODE(arg);
1187 else
1188 return converterr("unicode", arg, msgbuf, bufsize);
1189 }
1190 break;
1191 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001192#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001193
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001194 case 'S': { /* string object */
1195 PyObject **p = va_arg(*p_va, PyObject **);
1196 if (PyString_Check(arg))
1197 *p = arg;
1198 else
1199 return converterr("string", arg, msgbuf, bufsize);
1200 break;
1201 }
1202
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001203#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001204 case 'U': { /* Unicode object */
1205 PyObject **p = va_arg(*p_va, PyObject **);
1206 if (PyUnicode_Check(arg))
1207 *p = arg;
1208 else
1209 return converterr("unicode", arg, msgbuf, bufsize);
1210 break;
1211 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001212#endif
Guido van Rossumfccfe891998-05-15 22:04:07 +00001213
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001214 case 'O': { /* object */
1215 PyTypeObject *type;
1216 PyObject **p;
1217 if (*format == '!') {
1218 type = va_arg(*p_va, PyTypeObject*);
1219 p = va_arg(*p_va, PyObject **);
1220 format++;
1221 if (PyType_IsSubtype(arg->ob_type, type))
1222 *p = arg;
1223 else
1224 return converterr(type->tp_name, arg, msgbuf, bufsize);
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001225
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001226 }
1227 else if (*format == '?') {
1228 inquiry pred = va_arg(*p_va, inquiry);
1229 p = va_arg(*p_va, PyObject **);
1230 format++;
1231 if ((*pred)(arg))
1232 *p = arg;
1233 else
1234 return converterr("(unspecified)",
1235 arg, msgbuf, bufsize);
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001236
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001237 }
1238 else if (*format == '&') {
1239 typedef int (*converter)(PyObject *, void *);
1240 converter convert = va_arg(*p_va, converter);
1241 void *addr = va_arg(*p_va, void *);
1242 format++;
1243 if (! (*convert)(arg, addr))
1244 return converterr("(unspecified)",
1245 arg, msgbuf, bufsize);
1246 }
1247 else {
1248 p = va_arg(*p_va, PyObject **);
1249 *p = arg;
1250 }
1251 break;
1252 }
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001253
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001254
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001255 case 'w': { /* memory buffer, read-write access */
1256 void **p = va_arg(*p_va, void **);
1257 void *res;
1258 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1259 Py_ssize_t count;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001260
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001261 if (pb && pb->bf_releasebuffer && *format != '*')
1262 /* Buffer must be released, yet caller does not use
1263 the Py_buffer protocol. */
1264 return converterr("pinned buffer", arg, msgbuf, bufsize);
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001265
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001266 if (pb && pb->bf_getbuffer && *format == '*') {
1267 /* Caller is interested in Py_buffer, and the object
1268 supports it directly. */
1269 format++;
1270 if (pb->bf_getbuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1271 PyErr_Clear();
1272 return converterr("read-write buffer", arg, msgbuf, bufsize);
1273 }
1274 if (addcleanup(p, freelist, cleanup_buffer)) {
1275 return converterr(
1276 "(cleanup problem)",
1277 arg, msgbuf, bufsize);
1278 }
1279 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C'))
1280 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1281 break;
1282 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001283
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001284 if (pb == NULL ||
1285 pb->bf_getwritebuffer == NULL ||
1286 pb->bf_getsegcount == NULL)
1287 return converterr("read-write buffer", arg, msgbuf, bufsize);
1288 if ((*pb->bf_getsegcount)(arg, NULL) != 1)
1289 return converterr("single-segment read-write buffer",
1290 arg, msgbuf, bufsize);
1291 if ((count = pb->bf_getwritebuffer(arg, 0, &res)) < 0)
1292 return converterr("(unspecified)", arg, msgbuf, bufsize);
1293 if (*format == '*') {
1294 PyBuffer_FillInfo((Py_buffer*)p, arg, res, count, 1, 0);
1295 format++;
1296 }
1297 else {
1298 *p = res;
1299 if (*format == '#') {
1300 FETCH_SIZE;
1301 STORE_SIZE(count);
1302 format++;
1303 }
1304 }
1305 break;
1306 }
1307
1308 case 't': { /* 8-bit character buffer, read-only access */
1309 char **p = va_arg(*p_va, char **);
1310 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1311 Py_ssize_t count;
1312
1313 if (*format++ != '#')
1314 return converterr(
1315 "invalid use of 't' format character",
1316 arg, msgbuf, bufsize);
1317 if (!PyType_HasFeature(arg->ob_type,
1318 Py_TPFLAGS_HAVE_GETCHARBUFFER) ||
1319 pb == NULL || pb->bf_getcharbuffer == NULL ||
1320 pb->bf_getsegcount == NULL)
1321 return converterr(
1322 "string or read-only character buffer",
1323 arg, msgbuf, bufsize);
1324
1325 if (pb->bf_getsegcount(arg, NULL) != 1)
1326 return converterr(
1327 "string or single-segment read-only buffer",
1328 arg, msgbuf, bufsize);
1329
1330 if (pb->bf_releasebuffer)
1331 return converterr(
1332 "string or pinned buffer",
1333 arg, msgbuf, bufsize);
1334
1335 count = pb->bf_getcharbuffer(arg, 0, p);
1336 if (count < 0)
1337 return converterr("(unspecified)", arg, msgbuf, bufsize);
1338 {
1339 FETCH_SIZE;
1340 STORE_SIZE(count);
1341 }
1342 break;
1343 }
1344
1345 default:
1346 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
1347
1348 }
1349
1350 *p_format = format;
1351 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001352}
Guido van Rossumaa354651996-08-19 19:32:04 +00001353
Martin v. Löwis18e16552006-02-15 17:27:45 +00001354static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001355convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001356{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001357 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1358 Py_ssize_t count;
1359 if (pb == NULL ||
1360 pb->bf_getreadbuffer == NULL ||
1361 pb->bf_getsegcount == NULL ||
1362 pb->bf_releasebuffer != NULL) {
1363 *errmsg = "string or read-only buffer";
1364 return -1;
1365 }
1366 if ((*pb->bf_getsegcount)(arg, NULL) != 1) {
1367 *errmsg = "string or single-segment read-only buffer";
1368 return -1;
1369 }
1370 if ((count = (*pb->bf_getreadbuffer)(arg, 0, p)) < 0) {
1371 *errmsg = "(unspecified)";
1372 }
1373 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001374}
Guido van Rossumaa354651996-08-19 19:32:04 +00001375
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001376static int
Neal Norwitz18aa3882008-08-24 05:04:52 +00001377getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001378{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001379 void *buf;
1380 Py_ssize_t count;
1381 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1382 if (pb == NULL) {
1383 *errmsg = "string or buffer";
1384 return -1;
1385 }
1386 if (pb->bf_getbuffer) {
1387 if (pb->bf_getbuffer(arg, view, 0) < 0) {
1388 *errmsg = "convertible to a buffer";
1389 return -1;
1390 }
1391 if (!PyBuffer_IsContiguous(view, 'C')) {
1392 *errmsg = "contiguous buffer";
1393 return -1;
1394 }
1395 return 0;
1396 }
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001397
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001398 count = convertbuffer(arg, &buf, errmsg);
1399 if (count < 0) {
1400 *errmsg = "convertible to a buffer";
1401 return count;
1402 }
1403 PyBuffer_FillInfo(view, NULL, buf, count, 1, 0);
1404 return 0;
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001405}
1406
Guido van Rossumaa354651996-08-19 19:32:04 +00001407/* Support for keyword arguments donated by
1408 Geoff Philbrick <philbric@delphi.hks.com> */
1409
Tim Petersf8cd3e82001-10-27 04:26:57 +00001410/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001411int
1412PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001413 PyObject *keywords,
1414 const char *format,
1415 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001416{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001417 int retval;
1418 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001419
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001420 if ((args == NULL || !PyTuple_Check(args)) ||
1421 (keywords != NULL && !PyDict_Check(keywords)) ||
1422 format == NULL ||
1423 kwlist == NULL)
1424 {
1425 PyErr_BadInternalCall();
1426 return 0;
1427 }
Tim Peters45772cd2001-10-27 03:58:40 +00001428
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001429 va_start(va, kwlist);
1430 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1431 va_end(va);
1432 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001433}
1434
1435int
1436_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001437 PyObject *keywords,
1438 const char *format,
1439 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001440{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001441 int retval;
1442 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001443
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001444 if ((args == NULL || !PyTuple_Check(args)) ||
1445 (keywords != NULL && !PyDict_Check(keywords)) ||
1446 format == NULL ||
1447 kwlist == NULL)
1448 {
1449 PyErr_BadInternalCall();
1450 return 0;
1451 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001452
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001453 va_start(va, kwlist);
1454 retval = vgetargskeywords(args, keywords, format,
1455 kwlist, &va, FLAG_SIZE_T);
1456 va_end(va);
1457 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001458}
1459
1460
Brett Cannon711e7d92004-07-10 22:20:32 +00001461int
1462PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001463 PyObject *keywords,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001464 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001465 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001466{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001467 int retval;
1468 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001469
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001470 if ((args == NULL || !PyTuple_Check(args)) ||
1471 (keywords != NULL && !PyDict_Check(keywords)) ||
1472 format == NULL ||
1473 kwlist == NULL)
1474 {
1475 PyErr_BadInternalCall();
1476 return 0;
1477 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001478
1479#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001480 memcpy(lva, va, sizeof(va_list));
Brett Cannon711e7d92004-07-10 22:20:32 +00001481#else
1482#ifdef __va_copy
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001483 __va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001484#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001485 lva = va;
Brett Cannon711e7d92004-07-10 22:20:32 +00001486#endif
1487#endif
1488
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001489 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1490 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001491}
1492
1493int
1494_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001495 PyObject *keywords,
1496 const char *format,
1497 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001498{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001499 int retval;
1500 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001501
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001502 if ((args == NULL || !PyTuple_Check(args)) ||
1503 (keywords != NULL && !PyDict_Check(keywords)) ||
1504 format == NULL ||
1505 kwlist == NULL)
1506 {
1507 PyErr_BadInternalCall();
1508 return 0;
1509 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001510
1511#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001512 memcpy(lva, va, sizeof(va_list));
Martin v. Löwis18e16552006-02-15 17:27:45 +00001513#else
1514#ifdef __va_copy
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001515 __va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001516#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001517 lva = va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001518#endif
1519#endif
1520
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001521 retval = vgetargskeywords(args, keywords, format,
1522 kwlist, &lva, FLAG_SIZE_T);
1523 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001524}
1525
Christian Heimesea837932008-02-26 17:23:51 +00001526#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001527
Guido van Rossumaa354651996-08-19 19:32:04 +00001528static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001529vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001530 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001531{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001532 char msgbuf[512];
1533 int levels[32];
1534 const char *fname, *msg, *custom_msg, *keyword;
1535 int min = INT_MAX;
1536 int i, len, nargs, nkeywords;
1537 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001538
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001539 assert(args != NULL && PyTuple_Check(args));
1540 assert(keywords == NULL || PyDict_Check(keywords));
1541 assert(format != NULL);
1542 assert(kwlist != NULL);
1543 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001544
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001545 /* grab the function name or custom error msg first (mutually exclusive) */
1546 fname = strchr(format, ':');
1547 if (fname) {
1548 fname++;
1549 custom_msg = NULL;
1550 }
1551 else {
1552 custom_msg = strchr(format,';');
1553 if (custom_msg)
1554 custom_msg++;
1555 }
Christian Heimesea837932008-02-26 17:23:51 +00001556
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001557 /* scan kwlist and get greatest possible nbr of args */
1558 for (len=0; kwlist[len]; len++)
1559 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001560
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001561 nargs = PyTuple_GET_SIZE(args);
1562 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1563 if (nargs + nkeywords > len) {
1564 PyErr_Format(PyExc_TypeError, "%s%s takes at most %d "
1565 "argument%s (%d given)",
1566 (fname == NULL) ? "function" : fname,
1567 (fname == NULL) ? "" : "()",
1568 len,
1569 (len == 1) ? "" : "s",
1570 nargs + nkeywords);
1571 return 0;
1572 }
Tim Petersc2f01122001-10-27 07:25:06 +00001573
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001574 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1575 for (i = 0; i < len; i++) {
1576 keyword = kwlist[i];
1577 if (*format == '|') {
1578 min = i;
1579 format++;
1580 }
1581 if (IS_END_OF_FORMAT(*format)) {
1582 PyErr_Format(PyExc_RuntimeError,
1583 "More keyword list entries (%d) than "
1584 "format specifiers (%d)", len, i);
1585 return cleanreturn(0, freelist);
1586 }
1587 current_arg = NULL;
1588 if (nkeywords) {
1589 current_arg = PyDict_GetItemString(keywords, keyword);
1590 }
1591 if (current_arg) {
1592 --nkeywords;
1593 if (i < nargs) {
1594 /* arg present in tuple and in dict */
1595 PyErr_Format(PyExc_TypeError,
1596 "Argument given by name ('%s') "
1597 "and position (%d)",
1598 keyword, i+1);
1599 return cleanreturn(0, freelist);
1600 }
1601 }
1602 else if (nkeywords && PyErr_Occurred())
1603 return cleanreturn(0, freelist);
1604 else if (i < nargs)
1605 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimesea837932008-02-26 17:23:51 +00001606
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001607 if (current_arg) {
1608 msg = convertitem(current_arg, &format, p_va, flags,
1609 levels, msgbuf, sizeof(msgbuf), &freelist);
1610 if (msg) {
1611 seterror(i+1, msg, levels, fname, custom_msg);
1612 return cleanreturn(0, freelist);
1613 }
1614 continue;
1615 }
Christian Heimesea837932008-02-26 17:23:51 +00001616
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001617 if (i < min) {
1618 PyErr_Format(PyExc_TypeError, "Required argument "
1619 "'%s' (pos %d) not found",
1620 keyword, i+1);
1621 return cleanreturn(0, freelist);
1622 }
1623 /* current code reports success when all required args
1624 * fulfilled and no keyword args left, with no further
1625 * validation. XXX Maybe skip this in debug build ?
1626 */
1627 if (!nkeywords)
1628 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001629
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001630 /* We are into optional args, skip thru to any remaining
1631 * keyword args */
1632 msg = skipitem(&format, p_va, flags);
1633 if (msg) {
1634 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1635 format);
1636 return cleanreturn(0, freelist);
1637 }
1638 }
Tim Petersb054be42001-10-27 05:07:41 +00001639
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001640 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
1641 PyErr_Format(PyExc_RuntimeError,
1642 "more argument specifiers than keyword list entries "
1643 "(remaining format:'%s')", format);
1644 return cleanreturn(0, freelist);
1645 }
Tim Petersc2f01122001-10-27 07:25:06 +00001646
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001647 /* make sure there are no extraneous keyword arguments */
1648 if (nkeywords > 0) {
1649 PyObject *key, *value;
1650 Py_ssize_t pos = 0;
1651 while (PyDict_Next(keywords, &pos, &key, &value)) {
1652 int match = 0;
1653 char *ks;
1654 if (!PyString_Check(key)) {
1655 PyErr_SetString(PyExc_TypeError,
1656 "keywords must be strings");
1657 return cleanreturn(0, freelist);
1658 }
1659 ks = PyString_AsString(key);
1660 for (i = 0; i < len; i++) {
1661 if (!strcmp(ks, kwlist[i])) {
1662 match = 1;
1663 break;
1664 }
1665 }
1666 if (!match) {
1667 PyErr_Format(PyExc_TypeError,
1668 "'%s' is an invalid keyword "
1669 "argument for this function",
1670 ks);
1671 return cleanreturn(0, freelist);
1672 }
1673 }
1674 }
1675
1676 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001677}
1678
1679
1680static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001681skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001682{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001683 const char *format = *p_format;
1684 char c = *format++;
Georg Brandl6dd14612005-09-14 19:29:53 +00001685
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001686 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001687
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001688 /* simple codes
1689 * The individual types (second arg of va_arg) are irrelevant */
1690
1691 case 'b': /* byte -- very short int */
1692 case 'B': /* byte as bitfield */
1693 case 'h': /* short int */
1694 case 'H': /* short int as bitfield */
1695 case 'i': /* int */
1696 case 'I': /* int sized bitfield */
1697 case 'l': /* long int */
1698 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001699#ifdef HAVE_LONG_LONG
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001700 case 'L': /* PY_LONG_LONG */
1701 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001702#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001703 case 'f': /* float */
1704 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001705#ifndef WITHOUT_COMPLEX
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001706 case 'D': /* complex double */
Georg Brandl6dd14612005-09-14 19:29:53 +00001707#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001708 case 'c': /* char */
1709 {
1710 (void) va_arg(*p_va, void *);
1711 break;
1712 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001713
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001714 case 'n': /* Py_ssize_t */
1715 {
1716 (void) va_arg(*p_va, Py_ssize_t *);
1717 break;
1718 }
1719
1720 /* string codes */
1721
1722 case 'e': /* string with encoding */
1723 {
1724 (void) va_arg(*p_va, const char *);
1725 if (!(*format == 's' || *format == 't'))
1726 /* after 'e', only 's' and 't' is allowed */
1727 goto err;
1728 format++;
1729 /* explicit fallthrough to string cases */
1730 }
1731
1732 case 's': /* string */
1733 case 'z': /* string or None */
Georg Brandl6dd14612005-09-14 19:29:53 +00001734#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001735 case 'u': /* unicode string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001736#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001737 case 't': /* buffer, read-only */
1738 case 'w': /* buffer, read-write */
1739 {
1740 (void) va_arg(*p_va, char **);
1741 if (*format == '#') {
1742 if (flags & FLAG_SIZE_T)
1743 (void) va_arg(*p_va, Py_ssize_t *);
1744 else
1745 (void) va_arg(*p_va, int *);
1746 format++;
1747 } else if ((c == 's' || c == 'z') && *format == '*') {
1748 format++;
1749 }
1750 break;
1751 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001752
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001753 /* object codes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001754
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001755 case 'S': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001756#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001757 case 'U': /* unicode string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001758#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001759 {
1760 (void) va_arg(*p_va, PyObject **);
1761 break;
1762 }
Christian Heimesea837932008-02-26 17:23:51 +00001763
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001764 case 'O': /* object */
1765 {
1766 if (*format == '!') {
1767 format++;
1768 (void) va_arg(*p_va, PyTypeObject*);
1769 (void) va_arg(*p_va, PyObject **);
1770 }
1771 else if (*format == '&') {
1772 typedef int (*converter)(PyObject *, void *);
1773 (void) va_arg(*p_va, converter);
1774 (void) va_arg(*p_va, void *);
1775 format++;
1776 }
1777 else {
1778 (void) va_arg(*p_va, PyObject **);
1779 }
1780 break;
1781 }
Christian Heimesea837932008-02-26 17:23:51 +00001782
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001783 case '(': /* bypass tuple, not handled at all previously */
1784 {
1785 char *msg;
1786 for (;;) {
1787 if (*format==')')
1788 break;
1789 if (IS_END_OF_FORMAT(*format))
1790 return "Unmatched left paren in format "
1791 "string";
1792 msg = skipitem(&format, p_va, flags);
1793 if (msg)
1794 return msg;
1795 }
1796 format++;
1797 break;
1798 }
Christian Heimesea837932008-02-26 17:23:51 +00001799
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001800 case ')':
1801 return "Unmatched right paren in format string";
1802
1803 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001804err:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001805 return "impossible<bad format char>";
Georg Brandl6dd14612005-09-14 19:29:53 +00001806
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001807 }
1808
1809 *p_format = format;
1810 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001811}
Fred Drakee4616e62001-10-23 21:09:29 +00001812
1813
1814int
Martin v. Löwis76246742006-03-01 04:06:10 +00001815PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001816{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001817 Py_ssize_t i, l;
1818 PyObject **o;
1819 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001820
1821#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001822 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001823#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001824 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001825#endif
1826
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001827 assert(min >= 0);
1828 assert(min <= max);
1829 if (!PyTuple_Check(args)) {
1830 PyErr_SetString(PyExc_SystemError,
1831 "PyArg_UnpackTuple() argument list is not a tuple");
1832 return 0;
1833 }
1834 l = PyTuple_GET_SIZE(args);
1835 if (l < min) {
1836 if (name != NULL)
1837 PyErr_Format(
1838 PyExc_TypeError,
1839 "%s expected %s%zd arguments, got %zd",
1840 name, (min == max ? "" : "at least "), min, l);
1841 else
1842 PyErr_Format(
1843 PyExc_TypeError,
1844 "unpacked tuple should have %s%zd elements,"
1845 " but has %zd",
1846 (min == max ? "" : "at least "), min, l);
1847 va_end(vargs);
1848 return 0;
1849 }
1850 if (l > max) {
1851 if (name != NULL)
1852 PyErr_Format(
1853 PyExc_TypeError,
1854 "%s expected %s%zd arguments, got %zd",
1855 name, (min == max ? "" : "at most "), max, l);
1856 else
1857 PyErr_Format(
1858 PyExc_TypeError,
1859 "unpacked tuple should have %s%zd elements,"
1860 " but has %zd",
1861 (min == max ? "" : "at most "), max, l);
1862 va_end(vargs);
1863 return 0;
1864 }
1865 for (i = 0; i < l; i++) {
1866 o = va_arg(vargs, PyObject **);
1867 *o = PyTuple_GET_ITEM(args, i);
1868 }
1869 va_end(vargs);
1870 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001871}
Georg Brandl02c42872005-08-26 06:42:30 +00001872
1873
1874/* For type constructors that don't take keyword args
1875 *
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001876 * Sets a TypeError and returns 0 if the kwds dict is
Walter Dörwaldd14bf612006-09-21 15:09:55 +00001877 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001878 */
1879int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001880_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001881{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001882 if (kw == NULL)
1883 return 1;
1884 if (!PyDict_CheckExact(kw)) {
1885 PyErr_BadInternalCall();
1886 return 0;
1887 }
1888 if (PyDict_Size(kw) == 0)
1889 return 1;
1890
1891 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1892 funcname);
1893 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001894}
Anthony Baxter97300382006-04-12 04:38:54 +00001895#ifdef __cplusplus
1896};
1897#endif