blob: bd15c2e08991ed772e574771bd0a63b094ab59ca [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) {
Serhiy Storchaka36ae29c2016-02-08 01:05:48 +0200349 seterror(i+1, msg, levels, fname, message);
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000350 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);
Serhiy Storchaka36ae29c2016-02-08 01:05:48 +0200536 if (expected[0] == '(') {
537 PyOS_snprintf(msgbuf, bufsize,
538 "%.100s", expected);
539 strncpy(msgbuf, expected, bufsize);
540 msgbuf[bufsize-1] = '\0';
541 }
542 else {
543 PyOS_snprintf(msgbuf, bufsize,
544 "must be %.50s, not %.50s", expected,
545 arg == Py_None ? "None" : arg->ob_type->tp_name);
546 }
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000547 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000548}
549
550#define CONV_UNICODE "(unicode conversion error)"
551
Neil Schemenauer5042da62003-02-04 20:59:40 +0000552/* explicitly check for float arguments when integers are expected. For now
553 * signal a warning. Returns true if an exception was raised. */
554static int
Mark Dickinson1b34d252010-01-01 17:27:30 +0000555float_argument_warning(PyObject *arg)
Neil Schemenauer5042da62003-02-04 20:59:40 +0000556{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000557 if (PyFloat_Check(arg) &&
558 PyErr_Warn(PyExc_DeprecationWarning,
559 "integer argument expected, got float" ))
560 return 1;
561 else
562 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000563}
564
Mark Dickinson1b34d252010-01-01 17:27:30 +0000565/* explicitly check for float arguments when integers are expected. Raises
566 TypeError and returns true for float arguments. */
567static int
568float_argument_error(PyObject *arg)
569{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000570 if (PyFloat_Check(arg)) {
571 PyErr_SetString(PyExc_TypeError,
572 "integer argument expected, got float");
573 return 1;
574 }
575 else
576 return 0;
Mark Dickinson1b34d252010-01-01 17:27:30 +0000577}
578
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000579/* Convert a non-tuple argument. Return NULL if conversion went OK,
580 or a string with a message describing the failure. The message is
581 formatted as "must be <desired type>, not <actual type>".
582 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000583 Don't call if a tuple is expected.
584
585 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000586*/
587
588static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000589convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000590 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000591{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000592 /* For # codes */
593#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
594 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
595 else q=va_arg(*p_va, int*);
Victor Stinner0a92d182011-05-03 15:09:24 +0200596#define STORE_SIZE(s) \
597 if (flags & FLAG_SIZE_T) \
598 *q2=s; \
599 else { \
600 if (INT_MAX < s) { \
601 PyErr_SetString(PyExc_OverflowError, \
602 "size does not fit in an int"); \
603 return converterr("", arg, msgbuf, bufsize); \
604 } \
605 *q=s; \
606 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000607#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
608
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000609 const char *format = *p_format;
610 char c = *format++;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000611#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000612 PyObject *uarg;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000613#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000614
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000615 switch (c) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000616
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000617 case 'b': { /* unsigned byte -- very short int */
618 char *p = va_arg(*p_va, char *);
619 long ival;
620 if (float_argument_error(arg))
621 return converterr("integer<b>", arg, msgbuf, bufsize);
622 ival = PyInt_AsLong(arg);
623 if (ival == -1 && PyErr_Occurred())
624 return converterr("integer<b>", arg, msgbuf, bufsize);
625 else if (ival < 0) {
626 PyErr_SetString(PyExc_OverflowError,
627 "unsigned byte integer is less than minimum");
628 return converterr("integer<b>", arg, msgbuf, bufsize);
629 }
630 else if (ival > UCHAR_MAX) {
631 PyErr_SetString(PyExc_OverflowError,
632 "unsigned byte integer is greater than maximum");
633 return converterr("integer<b>", arg, msgbuf, bufsize);
634 }
635 else
636 *p = (unsigned char) ival;
637 break;
638 }
639
640 case 'B': {/* byte sized bitfield - both signed and unsigned
641 values allowed */
642 char *p = va_arg(*p_va, char *);
643 long ival;
644 if (float_argument_error(arg))
645 return converterr("integer<B>", arg, msgbuf, bufsize);
646 ival = PyInt_AsUnsignedLongMask(arg);
647 if (ival == -1 && PyErr_Occurred())
648 return converterr("integer<B>", arg, msgbuf, bufsize);
649 else
650 *p = (unsigned char) ival;
651 break;
652 }
653
654 case 'h': {/* signed short int */
655 short *p = va_arg(*p_va, short *);
656 long ival;
657 if (float_argument_error(arg))
658 return converterr("integer<h>", arg, msgbuf, bufsize);
659 ival = PyInt_AsLong(arg);
660 if (ival == -1 && PyErr_Occurred())
661 return converterr("integer<h>", arg, msgbuf, bufsize);
662 else if (ival < SHRT_MIN) {
663 PyErr_SetString(PyExc_OverflowError,
664 "signed short integer is less than minimum");
665 return converterr("integer<h>", arg, msgbuf, bufsize);
666 }
667 else if (ival > SHRT_MAX) {
668 PyErr_SetString(PyExc_OverflowError,
669 "signed short integer is greater than maximum");
670 return converterr("integer<h>", arg, msgbuf, bufsize);
671 }
672 else
673 *p = (short) ival;
674 break;
675 }
676
677 case 'H': { /* short int sized bitfield, both signed and
678 unsigned allowed */
679 unsigned short *p = va_arg(*p_va, unsigned short *);
680 long ival;
681 if (float_argument_error(arg))
682 return converterr("integer<H>", arg, msgbuf, bufsize);
683 ival = PyInt_AsUnsignedLongMask(arg);
684 if (ival == -1 && PyErr_Occurred())
685 return converterr("integer<H>", arg, msgbuf, bufsize);
686 else
687 *p = (unsigned short) ival;
688 break;
689 }
690
691 case 'i': {/* signed int */
692 int *p = va_arg(*p_va, int *);
693 long ival;
694 if (float_argument_error(arg))
695 return converterr("integer<i>", arg, msgbuf, bufsize);
696 ival = PyInt_AsLong(arg);
697 if (ival == -1 && PyErr_Occurred())
698 return converterr("integer<i>", arg, msgbuf, bufsize);
699 else if (ival > INT_MAX) {
700 PyErr_SetString(PyExc_OverflowError,
701 "signed integer is greater than maximum");
702 return converterr("integer<i>", arg, msgbuf, bufsize);
703 }
704 else if (ival < INT_MIN) {
705 PyErr_SetString(PyExc_OverflowError,
706 "signed integer is less than minimum");
707 return converterr("integer<i>", arg, msgbuf, bufsize);
708 }
709 else
710 *p = ival;
711 break;
712 }
713
714 case 'I': { /* int sized bitfield, both signed and
715 unsigned allowed */
716 unsigned int *p = va_arg(*p_va, unsigned int *);
717 unsigned int ival;
718 if (float_argument_error(arg))
719 return converterr("integer<I>", arg, msgbuf, bufsize);
720 ival = (unsigned int)PyInt_AsUnsignedLongMask(arg);
721 if (ival == (unsigned int)-1 && PyErr_Occurred())
722 return converterr("integer<I>", arg, msgbuf, bufsize);
723 else
724 *p = ival;
725 break;
726 }
727
728 case 'n': /* Py_ssize_t */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000729#if SIZEOF_SIZE_T != SIZEOF_LONG
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000730 {
731 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
732 Py_ssize_t ival;
733 if (float_argument_error(arg))
734 return converterr("integer<n>", arg, msgbuf, bufsize);
735 ival = PyInt_AsSsize_t(arg);
736 if (ival == -1 && PyErr_Occurred())
737 return converterr("integer<n>", arg, msgbuf, bufsize);
738 *p = ival;
739 break;
740 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000741#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000742 /* Fall through from 'n' to 'l' if Py_ssize_t is int */
743 case 'l': {/* long int */
744 long *p = va_arg(*p_va, long *);
745 long ival;
746 if (float_argument_error(arg))
747 return converterr("integer<l>", arg, msgbuf, bufsize);
748 ival = PyInt_AsLong(arg);
749 if (ival == -1 && PyErr_Occurred())
750 return converterr("integer<l>", arg, msgbuf, bufsize);
751 else
752 *p = ival;
753 break;
754 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000755
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000756 case 'k': { /* long sized bitfield */
757 unsigned long *p = va_arg(*p_va, unsigned long *);
758 unsigned long ival;
759 if (PyInt_Check(arg))
760 ival = PyInt_AsUnsignedLongMask(arg);
761 else if (PyLong_Check(arg))
762 ival = PyLong_AsUnsignedLongMask(arg);
763 else
Serhiy Storchaka36ae29c2016-02-08 01:05:48 +0200764 return converterr("an integer", arg, msgbuf, bufsize);
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000765 *p = ival;
766 break;
767 }
768
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000769#ifdef HAVE_LONG_LONG
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000770 case 'L': {/* PY_LONG_LONG */
771 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
772 PY_LONG_LONG ival;
773 if (float_argument_warning(arg))
774 return converterr("long<L>", arg, msgbuf, bufsize);
775 ival = PyLong_AsLongLong(arg);
776 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
777 return converterr("long<L>", arg, msgbuf, bufsize);
778 } else {
779 *p = ival;
780 }
781 break;
782 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000783
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000784 case 'K': { /* long long sized bitfield */
785 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
786 unsigned PY_LONG_LONG ival;
787 if (PyInt_Check(arg))
788 ival = PyInt_AsUnsignedLongMask(arg);
789 else if (PyLong_Check(arg))
790 ival = PyLong_AsUnsignedLongLongMask(arg);
791 else
Serhiy Storchaka36ae29c2016-02-08 01:05:48 +0200792 return converterr("an integer", arg, msgbuf, bufsize);
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000793 *p = ival;
794 break;
795 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000796#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000797
798 case 'f': {/* float */
799 float *p = va_arg(*p_va, float *);
800 double dval = PyFloat_AsDouble(arg);
801 if (PyErr_Occurred())
802 return converterr("float<f>", arg, msgbuf, bufsize);
803 else
804 *p = (float) dval;
805 break;
806 }
807
808 case 'd': {/* double */
809 double *p = va_arg(*p_va, double *);
810 double dval = PyFloat_AsDouble(arg);
811 if (PyErr_Occurred())
812 return converterr("float<d>", arg, msgbuf, bufsize);
813 else
814 *p = dval;
815 break;
816 }
817
Guido van Rossum530956d1996-07-21 02:27:43 +0000818#ifndef WITHOUT_COMPLEX
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000819 case 'D': {/* complex double */
820 Py_complex *p = va_arg(*p_va, Py_complex *);
821 Py_complex cval;
822 cval = PyComplex_AsCComplex(arg);
823 if (PyErr_Occurred())
824 return converterr("complex<D>", arg, msgbuf, bufsize);
825 else
826 *p = cval;
827 break;
828 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000829#endif /* WITHOUT_COMPLEX */
Martin v. Löwisf91d46a2008-08-12 14:49:50 +0000830
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000831 case 'c': {/* char */
832 char *p = va_arg(*p_va, char *);
833 if (PyString_Check(arg) && PyString_Size(arg) == 1)
834 *p = PyString_AS_STRING(arg)[0];
835 else
836 return converterr("char", arg, msgbuf, bufsize);
837 break;
838 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000839
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000840 case 's': {/* string */
841 if (*format == '*') {
842 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwisf91d46a2008-08-12 14:49:50 +0000843
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000844 if (PyString_Check(arg)) {
845 PyBuffer_FillInfo(p, arg,
846 PyString_AS_STRING(arg), PyString_GET_SIZE(arg),
847 1, 0);
848 }
Martin v. Löwisf91d46a2008-08-12 14:49:50 +0000849#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000850 else if (PyUnicode_Check(arg)) {
851 uarg = UNICODE_DEFAULT_ENCODING(arg);
852 if (uarg == NULL)
853 return converterr(CONV_UNICODE,
854 arg, msgbuf, bufsize);
855 PyBuffer_FillInfo(p, arg,
856 PyString_AS_STRING(uarg), PyString_GET_SIZE(uarg),
857 1, 0);
858 }
Martin v. Löwisf91d46a2008-08-12 14:49:50 +0000859#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000860 else { /* any buffer-like object */
861 char *buf;
862 if (getbuffer(arg, p, &buf) < 0)
863 return converterr(buf, arg, msgbuf, bufsize);
864 }
865 if (addcleanup(p, freelist, cleanup_buffer)) {
866 return converterr(
867 "(cleanup problem)",
868 arg, msgbuf, bufsize);
869 }
870 format++;
871 } else if (*format == '#') {
872 void **p = (void **)va_arg(*p_va, char **);
873 FETCH_SIZE;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000874
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000875 if (PyString_Check(arg)) {
876 *p = PyString_AS_STRING(arg);
877 STORE_SIZE(PyString_GET_SIZE(arg));
878 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000879#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000880 else if (PyUnicode_Check(arg)) {
881 uarg = UNICODE_DEFAULT_ENCODING(arg);
882 if (uarg == NULL)
883 return converterr(CONV_UNICODE,
884 arg, msgbuf, bufsize);
885 *p = PyString_AS_STRING(uarg);
886 STORE_SIZE(PyString_GET_SIZE(uarg));
887 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000888#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000889 else { /* any buffer-like object */
890 char *buf;
891 Py_ssize_t count = convertbuffer(arg, p, &buf);
892 if (count < 0)
893 return converterr(buf, arg, msgbuf, bufsize);
894 STORE_SIZE(count);
895 }
896 format++;
897 } else {
898 char **p = va_arg(*p_va, char **);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000899
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000900 if (PyString_Check(arg))
901 *p = PyString_AS_STRING(arg);
902#ifdef Py_USING_UNICODE
903 else if (PyUnicode_Check(arg)) {
904 uarg = UNICODE_DEFAULT_ENCODING(arg);
905 if (uarg == NULL)
906 return converterr(CONV_UNICODE,
907 arg, msgbuf, bufsize);
908 *p = PyString_AS_STRING(uarg);
909 }
910#endif
911 else
912 return converterr("string", arg, msgbuf, bufsize);
913 if ((Py_ssize_t)strlen(*p) != PyString_Size(arg))
914 return converterr("string without null bytes",
915 arg, msgbuf, bufsize);
916 }
917 break;
918 }
919
920 case 'z': {/* string, may be NULL (None) */
921 if (*format == '*') {
922 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
923
924 if (arg == Py_None)
925 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
926 else if (PyString_Check(arg)) {
927 PyBuffer_FillInfo(p, arg,
928 PyString_AS_STRING(arg), PyString_GET_SIZE(arg),
929 1, 0);
930 }
931#ifdef Py_USING_UNICODE
932 else if (PyUnicode_Check(arg)) {
933 uarg = UNICODE_DEFAULT_ENCODING(arg);
934 if (uarg == NULL)
935 return converterr(CONV_UNICODE,
936 arg, msgbuf, bufsize);
937 PyBuffer_FillInfo(p, arg,
938 PyString_AS_STRING(uarg), PyString_GET_SIZE(uarg),
939 1, 0);
940 }
941#endif
942 else { /* any buffer-like object */
943 char *buf;
944 if (getbuffer(arg, p, &buf) < 0)
945 return converterr(buf, arg, msgbuf, bufsize);
946 }
947 if (addcleanup(p, freelist, cleanup_buffer)) {
948 return converterr(
949 "(cleanup problem)",
950 arg, msgbuf, bufsize);
951 }
952 format++;
953 } else if (*format == '#') { /* any buffer-like object */
954 void **p = (void **)va_arg(*p_va, char **);
955 FETCH_SIZE;
956
957 if (arg == Py_None) {
958 *p = 0;
959 STORE_SIZE(0);
960 }
961 else if (PyString_Check(arg)) {
962 *p = PyString_AS_STRING(arg);
963 STORE_SIZE(PyString_GET_SIZE(arg));
964 }
965#ifdef Py_USING_UNICODE
966 else if (PyUnicode_Check(arg)) {
967 uarg = UNICODE_DEFAULT_ENCODING(arg);
968 if (uarg == NULL)
969 return converterr(CONV_UNICODE,
970 arg, msgbuf, bufsize);
971 *p = PyString_AS_STRING(uarg);
972 STORE_SIZE(PyString_GET_SIZE(uarg));
973 }
974#endif
975 else { /* any buffer-like object */
976 char *buf;
977 Py_ssize_t count = convertbuffer(arg, p, &buf);
978 if (count < 0)
979 return converterr(buf, arg, msgbuf, bufsize);
980 STORE_SIZE(count);
981 }
982 format++;
983 } else {
984 char **p = va_arg(*p_va, char **);
985
986 if (arg == Py_None)
987 *p = 0;
988 else if (PyString_Check(arg))
989 *p = PyString_AS_STRING(arg);
990#ifdef Py_USING_UNICODE
991 else if (PyUnicode_Check(arg)) {
992 uarg = UNICODE_DEFAULT_ENCODING(arg);
993 if (uarg == NULL)
994 return converterr(CONV_UNICODE,
995 arg, msgbuf, bufsize);
996 *p = PyString_AS_STRING(uarg);
997 }
998#endif
999 else
1000 return converterr("string or None",
1001 arg, msgbuf, bufsize);
1002 if (*format == '#') {
1003 FETCH_SIZE;
1004 assert(0); /* XXX redundant with if-case */
Victor Stinner645b9f62011-05-03 15:06:11 +02001005 if (arg == Py_None) {
1006 STORE_SIZE(0);
1007 } else {
1008 STORE_SIZE(PyString_Size(arg));
1009 }
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001010 format++;
1011 }
1012 else if (*p != NULL &&
1013 (Py_ssize_t)strlen(*p) != PyString_Size(arg))
1014 return converterr(
1015 "string without null bytes or None",
1016 arg, msgbuf, bufsize);
1017 }
1018 break;
1019 }
1020
1021 case 'e': {/* encoded string */
1022 char **buffer;
1023 const char *encoding;
1024 PyObject *s;
1025 Py_ssize_t size;
1026 int recode_strings;
1027
1028 /* Get 'e' parameter: the encoding name */
1029 encoding = (const char *)va_arg(*p_va, const char *);
1030#ifdef Py_USING_UNICODE
1031 if (encoding == NULL)
1032 encoding = PyUnicode_GetDefaultEncoding();
1033#endif
1034
1035 /* Get output buffer parameter:
1036 's' (recode all objects via Unicode) or
1037 't' (only recode non-string objects)
1038 */
1039 if (*format == 's')
1040 recode_strings = 1;
1041 else if (*format == 't')
1042 recode_strings = 0;
1043 else
1044 return converterr(
1045 "(unknown parser marker combination)",
1046 arg, msgbuf, bufsize);
1047 buffer = (char **)va_arg(*p_va, char **);
1048 format++;
1049 if (buffer == NULL)
1050 return converterr("(buffer is NULL)",
1051 arg, msgbuf, bufsize);
1052
1053 /* Encode object */
1054 if (!recode_strings && PyString_Check(arg)) {
1055 s = arg;
1056 Py_INCREF(s);
1057 }
1058 else {
1059#ifdef Py_USING_UNICODE
1060 PyObject *u;
1061
1062 /* Convert object to Unicode */
1063 u = PyUnicode_FromObject(arg);
1064 if (u == NULL)
1065 return converterr(
1066 "string or unicode or text buffer",
1067 arg, msgbuf, bufsize);
1068
1069 /* Encode object; use default error handling */
1070 s = PyUnicode_AsEncodedString(u,
1071 encoding,
1072 NULL);
1073 Py_DECREF(u);
1074 if (s == NULL)
1075 return converterr("(encoding failed)",
1076 arg, msgbuf, bufsize);
1077 if (!PyString_Check(s)) {
1078 Py_DECREF(s);
1079 return converterr(
1080 "(encoder failed to return a string)",
1081 arg, msgbuf, bufsize);
1082 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001083#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001084 return converterr("string<e>", arg, msgbuf, bufsize);
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001085#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001086 }
1087 size = PyString_GET_SIZE(s);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001088
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001089 /* Write output; output is guaranteed to be 0-terminated */
1090 if (*format == '#') {
1091 /* Using buffer length parameter '#':
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001092
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001093 - if *buffer is NULL, a new buffer of the
1094 needed size is allocated and the data
1095 copied into it; *buffer is updated to point
1096 to the new buffer; the caller is
1097 responsible for PyMem_Free()ing it after
1098 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001099
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001100 - if *buffer is not NULL, the data is
1101 copied to *buffer; *buffer_len has to be
1102 set to the size of the buffer on input;
1103 buffer overflow is signalled with an error;
1104 buffer has to provide enough room for the
1105 encoded string plus the trailing 0-byte
Fred Drake25871c02000-05-03 15:17:02 +00001106
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001107 - in both cases, *buffer_len is updated to
1108 the size of the buffer /excluding/ the
1109 trailing 0-byte
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001110
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001111 */
1112 FETCH_SIZE;
1113
1114 format++;
1115 if (q == NULL && q2 == NULL) {
1116 Py_DECREF(s);
1117 return converterr(
1118 "(buffer_len is NULL)",
1119 arg, msgbuf, bufsize);
1120 }
1121 if (*buffer == NULL) {
1122 *buffer = PyMem_NEW(char, size + 1);
1123 if (*buffer == NULL) {
1124 Py_DECREF(s);
1125 return converterr(
1126 "(memory error)",
1127 arg, msgbuf, bufsize);
1128 }
1129 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1130 Py_DECREF(s);
1131 return converterr(
1132 "(cleanup problem)",
1133 arg, msgbuf, bufsize);
1134 }
1135 } else {
1136 if (size + 1 > BUFFER_LEN) {
1137 Py_DECREF(s);
Serhiy Storchaka36ae29c2016-02-08 01:05:48 +02001138 PyErr_Format(PyExc_TypeError,
1139 "encoded string too long "
1140 "(%zd, maximum length %zd)",
1141 (Py_ssize_t)size, (Py_ssize_t)(BUFFER_LEN-1));
1142 return "";
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001143 }
1144 }
1145 memcpy(*buffer,
1146 PyString_AS_STRING(s),
1147 size + 1);
1148 STORE_SIZE(size);
1149 } else {
1150 /* Using a 0-terminated buffer:
1151
1152 - the encoded string has to be 0-terminated
1153 for this variant to work; if it is not, an
1154 error raised
1155
1156 - a new buffer of the needed size is
1157 allocated and the data copied into it;
1158 *buffer is updated to point to the new
1159 buffer; the caller is responsible for
1160 PyMem_Free()ing it after usage
1161
1162 */
1163 if ((Py_ssize_t)strlen(PyString_AS_STRING(s))
1164 != size) {
1165 Py_DECREF(s);
1166 return converterr(
Serhiy Storchaka36ae29c2016-02-08 01:05:48 +02001167 "encoded string without null bytes",
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001168 arg, msgbuf, bufsize);
1169 }
1170 *buffer = PyMem_NEW(char, size + 1);
1171 if (*buffer == NULL) {
1172 Py_DECREF(s);
1173 return converterr("(memory error)",
1174 arg, msgbuf, bufsize);
1175 }
1176 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1177 Py_DECREF(s);
1178 return converterr("(cleanup problem)",
1179 arg, msgbuf, bufsize);
1180 }
1181 memcpy(*buffer,
1182 PyString_AS_STRING(s),
1183 size + 1);
1184 }
1185 Py_DECREF(s);
1186 break;
1187 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001188
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001189#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001190 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1191 if (*format == '#') { /* any buffer-like object */
1192 void **p = (void **)va_arg(*p_va, char **);
1193 FETCH_SIZE;
1194 if (PyUnicode_Check(arg)) {
1195 *p = PyUnicode_AS_UNICODE(arg);
1196 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1197 }
1198 else {
1199 return converterr("cannot convert raw buffers",
1200 arg, msgbuf, bufsize);
1201 }
1202 format++;
1203 } else {
1204 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1205 if (PyUnicode_Check(arg))
1206 *p = PyUnicode_AS_UNICODE(arg);
1207 else
1208 return converterr("unicode", arg, msgbuf, bufsize);
1209 }
1210 break;
1211 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001212#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001213
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001214 case 'S': { /* string object */
1215 PyObject **p = va_arg(*p_va, PyObject **);
1216 if (PyString_Check(arg))
1217 *p = arg;
1218 else
1219 return converterr("string", arg, msgbuf, bufsize);
1220 break;
1221 }
1222
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001223#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001224 case 'U': { /* Unicode object */
1225 PyObject **p = va_arg(*p_va, PyObject **);
1226 if (PyUnicode_Check(arg))
1227 *p = arg;
1228 else
1229 return converterr("unicode", arg, msgbuf, bufsize);
1230 break;
1231 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001232#endif
Guido van Rossumfccfe891998-05-15 22:04:07 +00001233
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001234 case 'O': { /* object */
1235 PyTypeObject *type;
1236 PyObject **p;
1237 if (*format == '!') {
1238 type = va_arg(*p_va, PyTypeObject*);
1239 p = va_arg(*p_va, PyObject **);
1240 format++;
1241 if (PyType_IsSubtype(arg->ob_type, type))
1242 *p = arg;
1243 else
1244 return converterr(type->tp_name, arg, msgbuf, bufsize);
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001245
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001246 }
1247 else if (*format == '?') {
1248 inquiry pred = va_arg(*p_va, inquiry);
1249 p = va_arg(*p_va, PyObject **);
1250 format++;
1251 if ((*pred)(arg))
1252 *p = arg;
1253 else
1254 return converterr("(unspecified)",
1255 arg, msgbuf, bufsize);
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001256
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001257 }
1258 else if (*format == '&') {
1259 typedef int (*converter)(PyObject *, void *);
1260 converter convert = va_arg(*p_va, converter);
1261 void *addr = va_arg(*p_va, void *);
1262 format++;
1263 if (! (*convert)(arg, addr))
1264 return converterr("(unspecified)",
1265 arg, msgbuf, bufsize);
1266 }
1267 else {
1268 p = va_arg(*p_va, PyObject **);
1269 *p = arg;
1270 }
1271 break;
1272 }
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001273
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001274 case 'w': { /* memory buffer, read-write access */
1275 void **p = va_arg(*p_va, void **);
1276 void *res;
1277 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1278 Py_ssize_t count;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001279
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001280 if (pb && pb->bf_releasebuffer && *format != '*')
1281 /* Buffer must be released, yet caller does not use
1282 the Py_buffer protocol. */
1283 return converterr("pinned buffer", arg, msgbuf, bufsize);
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001284
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001285 if (pb && pb->bf_getbuffer && *format == '*') {
1286 /* Caller is interested in Py_buffer, and the object
1287 supports it directly. */
1288 format++;
1289 if (pb->bf_getbuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1290 PyErr_Clear();
1291 return converterr("read-write buffer", arg, msgbuf, bufsize);
1292 }
1293 if (addcleanup(p, freelist, cleanup_buffer)) {
1294 return converterr(
1295 "(cleanup problem)",
1296 arg, msgbuf, bufsize);
1297 }
1298 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C'))
1299 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1300 break;
1301 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001302
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001303 if (pb == NULL ||
1304 pb->bf_getwritebuffer == NULL ||
1305 pb->bf_getsegcount == NULL)
1306 return converterr("read-write buffer", arg, msgbuf, bufsize);
1307 if ((*pb->bf_getsegcount)(arg, NULL) != 1)
1308 return converterr("single-segment read-write buffer",
1309 arg, msgbuf, bufsize);
1310 if ((count = pb->bf_getwritebuffer(arg, 0, &res)) < 0)
1311 return converterr("(unspecified)", arg, msgbuf, bufsize);
1312 if (*format == '*') {
1313 PyBuffer_FillInfo((Py_buffer*)p, arg, res, count, 1, 0);
1314 format++;
1315 }
1316 else {
1317 *p = res;
1318 if (*format == '#') {
1319 FETCH_SIZE;
1320 STORE_SIZE(count);
1321 format++;
1322 }
1323 }
1324 break;
1325 }
1326
1327 case 't': { /* 8-bit character buffer, read-only access */
1328 char **p = va_arg(*p_va, char **);
1329 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1330 Py_ssize_t count;
1331
1332 if (*format++ != '#')
1333 return converterr(
1334 "invalid use of 't' format character",
1335 arg, msgbuf, bufsize);
1336 if (!PyType_HasFeature(arg->ob_type,
1337 Py_TPFLAGS_HAVE_GETCHARBUFFER) ||
1338 pb == NULL || pb->bf_getcharbuffer == NULL ||
1339 pb->bf_getsegcount == NULL)
1340 return converterr(
1341 "string or read-only character buffer",
1342 arg, msgbuf, bufsize);
1343
1344 if (pb->bf_getsegcount(arg, NULL) != 1)
1345 return converterr(
1346 "string or single-segment read-only buffer",
1347 arg, msgbuf, bufsize);
1348
1349 if (pb->bf_releasebuffer)
1350 return converterr(
1351 "string or pinned buffer",
1352 arg, msgbuf, bufsize);
1353
1354 count = pb->bf_getcharbuffer(arg, 0, p);
1355 if (count < 0)
1356 return converterr("(unspecified)", arg, msgbuf, bufsize);
1357 {
1358 FETCH_SIZE;
1359 STORE_SIZE(count);
1360 }
1361 break;
1362 }
1363
1364 default:
Serhiy Storchaka36ae29c2016-02-08 01:05:48 +02001365 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001366
1367 }
1368
1369 *p_format = format;
1370 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001371}
Guido van Rossumaa354651996-08-19 19:32:04 +00001372
Martin v. Löwis18e16552006-02-15 17:27:45 +00001373static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001374convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001375{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001376 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1377 Py_ssize_t count;
1378 if (pb == NULL ||
1379 pb->bf_getreadbuffer == NULL ||
1380 pb->bf_getsegcount == NULL ||
1381 pb->bf_releasebuffer != NULL) {
1382 *errmsg = "string or read-only buffer";
1383 return -1;
1384 }
1385 if ((*pb->bf_getsegcount)(arg, NULL) != 1) {
1386 *errmsg = "string or single-segment read-only buffer";
1387 return -1;
1388 }
1389 if ((count = (*pb->bf_getreadbuffer)(arg, 0, p)) < 0) {
1390 *errmsg = "(unspecified)";
1391 }
1392 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001393}
Guido van Rossumaa354651996-08-19 19:32:04 +00001394
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001395static int
Neal Norwitz18aa3882008-08-24 05:04:52 +00001396getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001397{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001398 void *buf;
1399 Py_ssize_t count;
1400 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1401 if (pb == NULL) {
1402 *errmsg = "string or buffer";
1403 return -1;
1404 }
1405 if (pb->bf_getbuffer) {
1406 if (pb->bf_getbuffer(arg, view, 0) < 0) {
1407 *errmsg = "convertible to a buffer";
1408 return -1;
1409 }
1410 if (!PyBuffer_IsContiguous(view, 'C')) {
1411 *errmsg = "contiguous buffer";
1412 return -1;
1413 }
1414 return 0;
1415 }
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001416
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001417 count = convertbuffer(arg, &buf, errmsg);
1418 if (count < 0) {
1419 *errmsg = "convertible to a buffer";
1420 return count;
1421 }
Kristján Valur Jónsson50b67782012-03-22 16:35:37 +00001422 PyBuffer_FillInfo(view, arg, buf, count, 1, 0);
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001423 return 0;
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00001424}
1425
Guido van Rossumaa354651996-08-19 19:32:04 +00001426/* Support for keyword arguments donated by
1427 Geoff Philbrick <philbric@delphi.hks.com> */
1428
Tim Petersf8cd3e82001-10-27 04:26:57 +00001429/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001430int
1431PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001432 PyObject *keywords,
1433 const char *format,
1434 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001435{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001436 int retval;
1437 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001438
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001439 if ((args == NULL || !PyTuple_Check(args)) ||
1440 (keywords != NULL && !PyDict_Check(keywords)) ||
1441 format == NULL ||
1442 kwlist == NULL)
1443 {
1444 PyErr_BadInternalCall();
1445 return 0;
1446 }
Tim Peters45772cd2001-10-27 03:58:40 +00001447
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001448 va_start(va, kwlist);
1449 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1450 va_end(va);
1451 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001452}
1453
1454int
1455_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001456 PyObject *keywords,
1457 const char *format,
1458 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001459{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001460 int retval;
1461 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001462
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001463 if ((args == NULL || !PyTuple_Check(args)) ||
1464 (keywords != NULL && !PyDict_Check(keywords)) ||
1465 format == NULL ||
1466 kwlist == NULL)
1467 {
1468 PyErr_BadInternalCall();
1469 return 0;
1470 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001471
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001472 va_start(va, kwlist);
1473 retval = vgetargskeywords(args, keywords, format,
1474 kwlist, &va, FLAG_SIZE_T);
1475 va_end(va);
1476 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001477}
1478
1479
Brett Cannon711e7d92004-07-10 22:20:32 +00001480int
1481PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001482 PyObject *keywords,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001483 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001484 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001485{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001486 int retval;
1487 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001488
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001489 if ((args == NULL || !PyTuple_Check(args)) ||
1490 (keywords != NULL && !PyDict_Check(keywords)) ||
1491 format == NULL ||
1492 kwlist == NULL)
1493 {
1494 PyErr_BadInternalCall();
1495 return 0;
1496 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001497
1498#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001499 memcpy(lva, va, sizeof(va_list));
Brett Cannon711e7d92004-07-10 22:20:32 +00001500#else
1501#ifdef __va_copy
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001502 __va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001503#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001504 lva = va;
Brett Cannon711e7d92004-07-10 22:20:32 +00001505#endif
1506#endif
1507
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001508 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1509 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001510}
1511
1512int
1513_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001514 PyObject *keywords,
1515 const char *format,
1516 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001517{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001518 int retval;
1519 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001520
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001521 if ((args == NULL || !PyTuple_Check(args)) ||
1522 (keywords != NULL && !PyDict_Check(keywords)) ||
1523 format == NULL ||
1524 kwlist == NULL)
1525 {
1526 PyErr_BadInternalCall();
1527 return 0;
1528 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001529
1530#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001531 memcpy(lva, va, sizeof(va_list));
Martin v. Löwis18e16552006-02-15 17:27:45 +00001532#else
1533#ifdef __va_copy
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001534 __va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001535#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001536 lva = va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001537#endif
1538#endif
1539
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001540 retval = vgetargskeywords(args, keywords, format,
1541 kwlist, &lva, FLAG_SIZE_T);
1542 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001543}
1544
Christian Heimesea837932008-02-26 17:23:51 +00001545#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001546
Guido van Rossumaa354651996-08-19 19:32:04 +00001547static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001548vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001549 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001550{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001551 char msgbuf[512];
1552 int levels[32];
1553 const char *fname, *msg, *custom_msg, *keyword;
1554 int min = INT_MAX;
1555 int i, len, nargs, nkeywords;
1556 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001557
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001558 assert(args != NULL && PyTuple_Check(args));
1559 assert(keywords == NULL || PyDict_Check(keywords));
1560 assert(format != NULL);
1561 assert(kwlist != NULL);
1562 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001563
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001564 /* grab the function name or custom error msg first (mutually exclusive) */
1565 fname = strchr(format, ':');
1566 if (fname) {
1567 fname++;
1568 custom_msg = NULL;
1569 }
1570 else {
1571 custom_msg = strchr(format,';');
1572 if (custom_msg)
1573 custom_msg++;
1574 }
Christian Heimesea837932008-02-26 17:23:51 +00001575
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001576 /* scan kwlist and get greatest possible nbr of args */
1577 for (len=0; kwlist[len]; len++)
1578 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001579
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001580 nargs = PyTuple_GET_SIZE(args);
1581 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1582 if (nargs + nkeywords > len) {
1583 PyErr_Format(PyExc_TypeError, "%s%s takes at most %d "
1584 "argument%s (%d given)",
1585 (fname == NULL) ? "function" : fname,
1586 (fname == NULL) ? "" : "()",
1587 len,
1588 (len == 1) ? "" : "s",
1589 nargs + nkeywords);
1590 return 0;
1591 }
Tim Petersc2f01122001-10-27 07:25:06 +00001592
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001593 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1594 for (i = 0; i < len; i++) {
1595 keyword = kwlist[i];
1596 if (*format == '|') {
1597 min = i;
1598 format++;
1599 }
1600 if (IS_END_OF_FORMAT(*format)) {
1601 PyErr_Format(PyExc_RuntimeError,
1602 "More keyword list entries (%d) than "
1603 "format specifiers (%d)", len, i);
1604 return cleanreturn(0, freelist);
1605 }
1606 current_arg = NULL;
1607 if (nkeywords) {
1608 current_arg = PyDict_GetItemString(keywords, keyword);
1609 }
1610 if (current_arg) {
1611 --nkeywords;
1612 if (i < nargs) {
1613 /* arg present in tuple and in dict */
1614 PyErr_Format(PyExc_TypeError,
1615 "Argument given by name ('%s') "
1616 "and position (%d)",
1617 keyword, i+1);
1618 return cleanreturn(0, freelist);
1619 }
1620 }
1621 else if (nkeywords && PyErr_Occurred())
1622 return cleanreturn(0, freelist);
1623 else if (i < nargs)
1624 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimesea837932008-02-26 17:23:51 +00001625
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001626 if (current_arg) {
1627 msg = convertitem(current_arg, &format, p_va, flags,
1628 levels, msgbuf, sizeof(msgbuf), &freelist);
1629 if (msg) {
1630 seterror(i+1, msg, levels, fname, custom_msg);
1631 return cleanreturn(0, freelist);
1632 }
1633 continue;
1634 }
Christian Heimesea837932008-02-26 17:23:51 +00001635
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001636 if (i < min) {
1637 PyErr_Format(PyExc_TypeError, "Required argument "
1638 "'%s' (pos %d) not found",
1639 keyword, i+1);
1640 return cleanreturn(0, freelist);
1641 }
1642 /* current code reports success when all required args
1643 * fulfilled and no keyword args left, with no further
1644 * validation. XXX Maybe skip this in debug build ?
1645 */
1646 if (!nkeywords)
1647 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001648
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001649 /* We are into optional args, skip thru to any remaining
1650 * keyword args */
1651 msg = skipitem(&format, p_va, flags);
1652 if (msg) {
1653 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1654 format);
1655 return cleanreturn(0, freelist);
1656 }
1657 }
Tim Petersb054be42001-10-27 05:07:41 +00001658
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001659 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
1660 PyErr_Format(PyExc_RuntimeError,
1661 "more argument specifiers than keyword list entries "
1662 "(remaining format:'%s')", format);
1663 return cleanreturn(0, freelist);
1664 }
Tim Petersc2f01122001-10-27 07:25:06 +00001665
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001666 /* make sure there are no extraneous keyword arguments */
1667 if (nkeywords > 0) {
1668 PyObject *key, *value;
1669 Py_ssize_t pos = 0;
1670 while (PyDict_Next(keywords, &pos, &key, &value)) {
1671 int match = 0;
1672 char *ks;
1673 if (!PyString_Check(key)) {
1674 PyErr_SetString(PyExc_TypeError,
1675 "keywords must be strings");
1676 return cleanreturn(0, freelist);
1677 }
1678 ks = PyString_AsString(key);
1679 for (i = 0; i < len; i++) {
1680 if (!strcmp(ks, kwlist[i])) {
1681 match = 1;
1682 break;
1683 }
1684 }
1685 if (!match) {
1686 PyErr_Format(PyExc_TypeError,
1687 "'%s' is an invalid keyword "
1688 "argument for this function",
1689 ks);
1690 return cleanreturn(0, freelist);
1691 }
1692 }
1693 }
1694
1695 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001696}
1697
1698
1699static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001700skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001701{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001702 const char *format = *p_format;
1703 char c = *format++;
Georg Brandl6dd14612005-09-14 19:29:53 +00001704
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001705 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001706
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001707 /* simple codes
1708 * The individual types (second arg of va_arg) are irrelevant */
1709
1710 case 'b': /* byte -- very short int */
1711 case 'B': /* byte as bitfield */
1712 case 'h': /* short int */
1713 case 'H': /* short int as bitfield */
1714 case 'i': /* int */
1715 case 'I': /* int sized bitfield */
1716 case 'l': /* long int */
1717 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001718#ifdef HAVE_LONG_LONG
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001719 case 'L': /* PY_LONG_LONG */
1720 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001721#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001722 case 'f': /* float */
1723 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001724#ifndef WITHOUT_COMPLEX
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001725 case 'D': /* complex double */
Georg Brandl6dd14612005-09-14 19:29:53 +00001726#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001727 case 'c': /* char */
1728 {
1729 (void) va_arg(*p_va, void *);
1730 break;
1731 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001732
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001733 case 'n': /* Py_ssize_t */
1734 {
1735 (void) va_arg(*p_va, Py_ssize_t *);
1736 break;
1737 }
1738
1739 /* string codes */
1740
1741 case 'e': /* string with encoding */
1742 {
1743 (void) va_arg(*p_va, const char *);
1744 if (!(*format == 's' || *format == 't'))
1745 /* after 'e', only 's' and 't' is allowed */
1746 goto err;
1747 format++;
1748 /* explicit fallthrough to string cases */
1749 }
1750
1751 case 's': /* string */
1752 case 'z': /* string or None */
Georg Brandl6dd14612005-09-14 19:29:53 +00001753#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001754 case 'u': /* unicode string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001755#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001756 case 't': /* buffer, read-only */
1757 case 'w': /* buffer, read-write */
1758 {
1759 (void) va_arg(*p_va, char **);
1760 if (*format == '#') {
1761 if (flags & FLAG_SIZE_T)
1762 (void) va_arg(*p_va, Py_ssize_t *);
1763 else
1764 (void) va_arg(*p_va, int *);
1765 format++;
1766 } else if ((c == 's' || c == 'z') && *format == '*') {
1767 format++;
1768 }
1769 break;
1770 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001771
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001772 /* object codes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001773
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001774 case 'S': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001775#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001776 case 'U': /* unicode string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001777#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001778 {
1779 (void) va_arg(*p_va, PyObject **);
1780 break;
1781 }
Christian Heimesea837932008-02-26 17:23:51 +00001782
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001783 case 'O': /* object */
1784 {
1785 if (*format == '!') {
1786 format++;
1787 (void) va_arg(*p_va, PyTypeObject*);
1788 (void) va_arg(*p_va, PyObject **);
1789 }
1790 else if (*format == '&') {
1791 typedef int (*converter)(PyObject *, void *);
1792 (void) va_arg(*p_va, converter);
1793 (void) va_arg(*p_va, void *);
1794 format++;
1795 }
1796 else {
1797 (void) va_arg(*p_va, PyObject **);
1798 }
1799 break;
1800 }
Christian Heimesea837932008-02-26 17:23:51 +00001801
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001802 case '(': /* bypass tuple, not handled at all previously */
1803 {
1804 char *msg;
1805 for (;;) {
1806 if (*format==')')
1807 break;
1808 if (IS_END_OF_FORMAT(*format))
1809 return "Unmatched left paren in format "
1810 "string";
1811 msg = skipitem(&format, p_va, flags);
1812 if (msg)
1813 return msg;
1814 }
1815 format++;
1816 break;
1817 }
Christian Heimesea837932008-02-26 17:23:51 +00001818
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001819 case ')':
1820 return "Unmatched right paren in format string";
1821
1822 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001823err:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001824 return "impossible<bad format char>";
Georg Brandl6dd14612005-09-14 19:29:53 +00001825
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001826 }
1827
1828 *p_format = format;
1829 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001830}
Fred Drakee4616e62001-10-23 21:09:29 +00001831
1832
1833int
Martin v. Löwis76246742006-03-01 04:06:10 +00001834PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001835{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001836 Py_ssize_t i, l;
1837 PyObject **o;
1838 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001839
1840#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001841 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001842#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001843 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001844#endif
1845
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001846 assert(min >= 0);
1847 assert(min <= max);
1848 if (!PyTuple_Check(args)) {
Christian Heimesd8edcb62012-09-10 13:16:45 +02001849 va_end(vargs);
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001850 PyErr_SetString(PyExc_SystemError,
1851 "PyArg_UnpackTuple() argument list is not a tuple");
1852 return 0;
1853 }
1854 l = PyTuple_GET_SIZE(args);
1855 if (l < min) {
1856 if (name != NULL)
1857 PyErr_Format(
1858 PyExc_TypeError,
1859 "%s expected %s%zd arguments, got %zd",
1860 name, (min == max ? "" : "at least "), min, l);
1861 else
1862 PyErr_Format(
1863 PyExc_TypeError,
1864 "unpacked tuple should have %s%zd elements,"
1865 " but has %zd",
1866 (min == max ? "" : "at least "), min, l);
1867 va_end(vargs);
1868 return 0;
1869 }
1870 if (l > max) {
1871 if (name != NULL)
1872 PyErr_Format(
1873 PyExc_TypeError,
1874 "%s expected %s%zd arguments, got %zd",
1875 name, (min == max ? "" : "at most "), max, l);
1876 else
1877 PyErr_Format(
1878 PyExc_TypeError,
1879 "unpacked tuple should have %s%zd elements,"
1880 " but has %zd",
1881 (min == max ? "" : "at most "), max, l);
1882 va_end(vargs);
1883 return 0;
1884 }
1885 for (i = 0; i < l; i++) {
1886 o = va_arg(vargs, PyObject **);
1887 *o = PyTuple_GET_ITEM(args, i);
1888 }
1889 va_end(vargs);
1890 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001891}
Georg Brandl02c42872005-08-26 06:42:30 +00001892
1893
1894/* For type constructors that don't take keyword args
1895 *
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001896 * Sets a TypeError and returns 0 if the kwds dict is
Walter Dörwaldd14bf612006-09-21 15:09:55 +00001897 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001898 */
1899int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001900_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001901{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001902 if (kw == NULL)
1903 return 1;
1904 if (!PyDict_CheckExact(kw)) {
1905 PyErr_BadInternalCall();
1906 return 0;
1907 }
1908 if (PyDict_Size(kw) == 0)
1909 return 1;
1910
1911 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1912 funcname);
1913 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001914}
Anthony Baxter97300382006-04-12 04:38:54 +00001915#ifdef __cplusplus
1916};
1917#endif