blob: 0009b35426339028b3af46e5231323de60d7c5dd [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
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00009#ifdef __cplusplus
Guido van Rossum98297ee2007-11-06 21:34:58 +000010extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +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 Pitrou7f14f0d2010-05-09 16:14:21 +000017 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000018int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000019 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000020
Thomas Wouters49fd7fa2006-04-21 10:40:58 +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 *);
Guido van Rossum98297ee2007-11-06 21:34:58 +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 Pitrou7f14f0d2010-05-09 16:14:21 +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 Pitrou7f14f0d2010-05-09 16:14:21 +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öwis423be952008-08-13 15:53:07 +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 Pitrou7f14f0d2010-05-09 16:14:21 +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 Pitrou7f14f0d2010-05-09 16:14:21 +000056 int retval;
57 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000058
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000059 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 Pitrou7f14f0d2010-05-09 16:14:21 +000068 int retval;
69 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000070
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000071 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 Pitrou7f14f0d2010-05-09 16:14:21 +000081 int retval;
82 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000083
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000084 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 Pitrou7f14f0d2010-05-09 16:14:21 +000093 int retval;
94 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000095
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000096 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 Pitrou7f14f0d2010-05-09 16:14:21 +0000106 va_list lva;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000107
108#ifdef VA_LIST_IS_ARRAY
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +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 Pitrou7f14f0d2010-05-09 16:14:21 +0000112 __va_copy(lva, va);
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000113#else
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +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 Pitrou7f14f0d2010-05-09 16:14:21 +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 Pitrou7f14f0d2010-05-09 16:14:21 +0000124 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000125
126#ifdef VA_LIST_IS_ARRAY
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000127 memcpy(lva, va, sizeof(va_list));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000128#else
129#ifdef __va_copy
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000130 __va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000131#else
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000132 lva = va;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000133#endif
134#endif
135
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +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
Benjamin Petersonb173f782009-05-05 22:31:58 +0000142#define GETARGS_CAPSULE_NAME_CLEANUP_PTR "getargs.cleanup_ptr"
143#define GETARGS_CAPSULE_NAME_CLEANUP_BUFFER "getargs.cleanup_buffer"
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000144#define GETARGS_CAPSULE_NAME_CLEANUP_CONVERT "getargs.cleanup_convert"
Benjamin Petersonb173f782009-05-05 22:31:58 +0000145
Antoine Pitrouf71995782008-08-29 18:37:05 +0000146static void
Benjamin Petersonb173f782009-05-05 22:31:58 +0000147cleanup_ptr(PyObject *self)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000148{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000149 void *ptr = PyCapsule_GetPointer(self, GETARGS_CAPSULE_NAME_CLEANUP_PTR);
150 if (ptr) {
151 PyMem_FREE(ptr);
152 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000153}
154
155static void
Benjamin Petersonb173f782009-05-05 22:31:58 +0000156cleanup_buffer(PyObject *self)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000157{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000158 Py_buffer *ptr = (Py_buffer *)PyCapsule_GetPointer(self, GETARGS_CAPSULE_NAME_CLEANUP_BUFFER);
159 if (ptr) {
160 PyBuffer_Release(ptr);
161 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000162}
163
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000164static int
Benjamin Petersonb173f782009-05-05 22:31:58 +0000165addcleanup(void *ptr, PyObject **freelist, PyCapsule_Destructor destr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000166{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000167 PyObject *cobj;
168 const char *name;
Benjamin Petersonb173f782009-05-05 22:31:58 +0000169
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000170 if (!*freelist) {
171 *freelist = PyList_New(0);
172 if (!*freelist) {
173 destr(ptr);
174 return -1;
175 }
176 }
Benjamin Petersonb173f782009-05-05 22:31:58 +0000177
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000178 if (destr == cleanup_ptr) {
179 name = GETARGS_CAPSULE_NAME_CLEANUP_PTR;
180 } else if (destr == cleanup_buffer) {
181 name = GETARGS_CAPSULE_NAME_CLEANUP_BUFFER;
182 } else {
183 return -1;
184 }
185 cobj = PyCapsule_New(ptr, name, destr);
186 if (!cobj) {
187 destr(ptr);
188 return -1;
189 }
190 if (PyList_Append(*freelist, cobj)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000191 Py_DECREF(cobj);
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000192 return -1;
193 }
194 Py_DECREF(cobj);
195 return 0;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000196}
197
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000198static void
199cleanup_convert(PyObject *self)
200{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000201 typedef int (*destr_t)(PyObject *, void *);
202 destr_t destr = (destr_t)PyCapsule_GetContext(self);
203 void *ptr = PyCapsule_GetPointer(self,
204 GETARGS_CAPSULE_NAME_CLEANUP_CONVERT);
205 if (ptr && destr)
206 destr(NULL, ptr);
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000207}
208
209static int
210addcleanup_convert(void *ptr, PyObject **freelist, int (*destr)(PyObject*,void*))
211{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000212 PyObject *cobj;
213 if (!*freelist) {
214 *freelist = PyList_New(0);
215 if (!*freelist) {
216 destr(NULL, ptr);
217 return -1;
218 }
219 }
220 cobj = PyCapsule_New(ptr, GETARGS_CAPSULE_NAME_CLEANUP_CONVERT,
221 cleanup_convert);
222 if (!cobj) {
223 destr(NULL, ptr);
224 return -1;
225 }
226 if (PyCapsule_SetContext(cobj, destr) == -1) {
227 /* This really should not happen. */
228 Py_FatalError("capsule refused setting of context.");
229 }
230 if (PyList_Append(*freelist, cobj)) {
231 Py_DECREF(cobj); /* This will also call destr. */
232 return -1;
233 }
234 Py_DECREF(cobj);
235 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000236}
237
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000238static int
239cleanreturn(int retval, PyObject *freelist)
240{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000241 if (freelist && retval != 0) {
242 /* We were successful, reset the destructors so that they
243 don't get called. */
244 Py_ssize_t len = PyList_GET_SIZE(freelist), i;
245 for (i = 0; i < len; i++)
246 PyCapsule_SetDestructor(PyList_GET_ITEM(freelist, i), NULL);
247 }
248 Py_XDECREF(freelist);
249 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000250}
251
252
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000253static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000254vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000255{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000256 char msgbuf[256];
257 int levels[32];
258 const char *fname = NULL;
259 const char *message = NULL;
260 int min = -1;
261 int max = 0;
262 int level = 0;
263 int endfmt = 0;
264 const char *formatsave = format;
265 Py_ssize_t i, len;
266 char *msg;
267 PyObject *freelist = NULL;
268 int compat = flags & FLAG_COMPAT;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000269
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000270 assert(compat || (args != (PyObject*)NULL));
271 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000272
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000273 while (endfmt == 0) {
274 int c = *format++;
275 switch (c) {
276 case '(':
277 if (level == 0)
278 max++;
279 level++;
280 if (level >= 30)
281 Py_FatalError("too many tuple nesting levels "
282 "in argument format string");
283 break;
284 case ')':
285 if (level == 0)
286 Py_FatalError("excess ')' in getargs format");
287 else
288 level--;
289 break;
290 case '\0':
291 endfmt = 1;
292 break;
293 case ':':
294 fname = format;
295 endfmt = 1;
296 break;
297 case ';':
298 message = format;
299 endfmt = 1;
300 break;
301 default:
302 if (level == 0) {
303 if (c == 'O')
304 max++;
305 else if (isalpha(Py_CHARMASK(c))) {
306 if (c != 'e') /* skip encoded */
307 max++;
308 } else if (c == '|')
309 min = max;
310 }
311 break;
312 }
313 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000314
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000315 if (level != 0)
316 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000317
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000318 if (min < 0)
319 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000320
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000321 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000322
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000323 if (compat) {
324 if (max == 0) {
325 if (args == NULL)
326 return 1;
327 PyOS_snprintf(msgbuf, sizeof(msgbuf),
328 "%.200s%s takes no arguments",
329 fname==NULL ? "function" : fname,
330 fname==NULL ? "" : "()");
331 PyErr_SetString(PyExc_TypeError, msgbuf);
332 return 0;
333 }
334 else if (min == 1 && max == 1) {
335 if (args == NULL) {
336 PyOS_snprintf(msgbuf, sizeof(msgbuf),
337 "%.200s%s takes at least one argument",
338 fname==NULL ? "function" : fname,
339 fname==NULL ? "" : "()");
340 PyErr_SetString(PyExc_TypeError, msgbuf);
341 return 0;
342 }
343 msg = convertitem(args, &format, p_va, flags, levels,
344 msgbuf, sizeof(msgbuf), &freelist);
345 if (msg == NULL)
346 return cleanreturn(1, freelist);
347 seterror(levels[0], msg, levels+1, fname, message);
348 return cleanreturn(0, freelist);
349 }
350 else {
351 PyErr_SetString(PyExc_SystemError,
352 "old style getargs format uses new features");
353 return 0;
354 }
355 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000356
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000357 if (!PyTuple_Check(args)) {
358 PyErr_SetString(PyExc_SystemError,
359 "new style getargs format but argument is not a tuple");
360 return 0;
361 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000362
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000363 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000364
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000365 if (len < min || max < len) {
366 if (message == NULL) {
367 PyOS_snprintf(msgbuf, sizeof(msgbuf),
368 "%.150s%s takes %s %d argument%s "
369 "(%ld given)",
370 fname==NULL ? "function" : fname,
371 fname==NULL ? "" : "()",
372 min==max ? "exactly"
373 : len < min ? "at least" : "at most",
374 len < min ? min : max,
375 (len < min ? min : max) == 1 ? "" : "s",
376 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
377 message = msgbuf;
378 }
379 PyErr_SetString(PyExc_TypeError, message);
380 return 0;
381 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000382
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000383 for (i = 0; i < len; i++) {
384 if (*format == '|')
385 format++;
386 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
387 flags, levels, msgbuf,
388 sizeof(msgbuf), &freelist);
389 if (msg) {
390 seterror(i+1, msg, levels, fname, msg);
391 return cleanreturn(0, freelist);
392 }
393 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000394
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000395 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
396 *format != '(' &&
397 *format != '|' && *format != ':' && *format != ';') {
398 PyErr_Format(PyExc_SystemError,
399 "bad format string: %.200s", formatsave);
400 return cleanreturn(0, freelist);
401 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000402
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000403 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000404}
405
406
407
408static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000409seterror(int iarg, const char *msg, int *levels, const char *fname,
410 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000411{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000412 char buf[512];
413 int i;
414 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000415
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000416 if (PyErr_Occurred())
417 return;
418 else if (message == NULL) {
419 if (fname != NULL) {
420 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
421 p += strlen(p);
422 }
423 if (iarg != 0) {
424 PyOS_snprintf(p, sizeof(buf) - (p - buf),
425 "argument %d", iarg);
426 i = 0;
427 p += strlen(p);
428 while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
429 PyOS_snprintf(p, sizeof(buf) - (p - buf),
430 ", item %d", levels[i]-1);
431 p += strlen(p);
432 i++;
433 }
434 }
435 else {
436 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
437 p += strlen(p);
438 }
439 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
440 message = buf;
441 }
442 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000443}
444
445
446/* Convert a tuple argument.
447 On entry, *p_format points to the character _after_ the opening '('.
448 On successful exit, *p_format points to the closing ')'.
449 If successful:
450 *p_format and *p_va are updated,
451 *levels and *msgbuf are untouched,
452 and NULL is returned.
453 If the argument is invalid:
454 *p_format is unchanged,
455 *p_va is undefined,
456 *levels is a 0-terminated list of item numbers,
457 *msgbuf contains an error message, whose format is:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000458 "must be <typename1>, not <typename2>", where:
459 <typename1> is the name of the expected type, and
460 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000461 and msgbuf is returned.
462*/
463
464static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000465converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000466 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000467 PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000468{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000469 int level = 0;
470 int n = 0;
471 const char *format = *p_format;
472 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000473
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000474 for (;;) {
475 int c = *format++;
476 if (c == '(') {
477 if (level == 0)
478 n++;
479 level++;
480 }
481 else if (c == ')') {
482 if (level == 0)
483 break;
484 level--;
485 }
486 else if (c == ':' || c == ';' || c == '\0')
487 break;
488 else if (level == 0 && isalpha(Py_CHARMASK(c)))
489 n++;
490 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000491
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000492 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
493 levels[0] = 0;
494 PyOS_snprintf(msgbuf, bufsize,
495 toplevel ? "expected %d arguments, not %.50s" :
496 "must be %d-item sequence, not %.50s",
497 n,
498 arg == Py_None ? "None" : arg->ob_type->tp_name);
499 return msgbuf;
500 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000501
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000502 if ((i = PySequence_Size(arg)) != n) {
503 levels[0] = 0;
504 PyOS_snprintf(msgbuf, bufsize,
505 toplevel ? "expected %d arguments, not %d" :
506 "must be sequence of length %d, not %d",
507 n, i);
508 return msgbuf;
509 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000510
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000511 format = *p_format;
512 for (i = 0; i < n; i++) {
513 char *msg;
514 PyObject *item;
515 item = PySequence_GetItem(arg, i);
516 if (item == NULL) {
517 PyErr_Clear();
518 levels[0] = i+1;
519 levels[1] = 0;
520 strncpy(msgbuf, "is not retrievable", bufsize);
521 return msgbuf;
522 }
523 msg = convertitem(item, &format, p_va, flags, levels+1,
524 msgbuf, bufsize, freelist);
525 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
526 Py_XDECREF(item);
527 if (msg != NULL) {
528 levels[0] = i+1;
529 return msg;
530 }
531 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000532
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000533 *p_format = format;
534 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000535}
536
537
538/* Convert a single item. */
539
540static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000541convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
542 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000543{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000544 char *msg;
545 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000546
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000547 if (*format == '(' /* ')' */) {
548 format++;
549 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
550 bufsize, 0, freelist);
551 if (msg == NULL)
552 format++;
553 }
554 else {
555 msg = convertsimple(arg, &format, p_va, flags,
556 msgbuf, bufsize, freelist);
557 if (msg != NULL)
558 levels[0] = 0;
559 }
560 if (msg == NULL)
561 *p_format = format;
562 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000563}
564
565
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000566
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000567#define UNICODE_DEFAULT_ENCODING(arg) \
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000568 _PyUnicode_AsDefaultEncodedString(arg, NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000569
570/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000571
572static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000573converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000574{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000575 assert(expected != NULL);
576 assert(arg != NULL);
577 PyOS_snprintf(msgbuf, bufsize,
578 "must be %.50s, not %.50s", expected,
579 arg == Py_None ? "None" : arg->ob_type->tp_name);
580 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000581}
582
583#define CONV_UNICODE "(unicode conversion error)"
584
Guido van Rossum45aecf42006-03-15 04:58:47 +0000585/* Explicitly check for float arguments when integers are expected.
586 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000587static int
588float_argument_error(PyObject *arg)
589{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000590 if (PyFloat_Check(arg)) {
591 PyErr_SetString(PyExc_TypeError,
592 "integer argument expected, got float" );
593 return 1;
594 }
595 else
596 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000597}
598
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000599/* Convert a non-tuple argument. Return NULL if conversion went OK,
600 or a string with a message describing the failure. The message is
601 formatted as "must be <desired type>, not <actual type>".
602 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000603 Don't call if a tuple is expected.
604
605 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000606*/
607
608static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000609convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000610 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000611{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000612 /* For # codes */
613#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
614 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
615 else q=va_arg(*p_va, int*);
Victor Stinner451385d2011-03-21 03:22:50 +0100616#define STORE_SIZE(s) \
617 if (flags & FLAG_SIZE_T) \
618 *q2=s; \
619 else { \
620 if (INT_MAX < s) { \
621 PyErr_SetString(PyExc_OverflowError, \
622 "size does not fit in an int"); \
623 return converterr("", arg, msgbuf, bufsize); \
624 } \
625 *q=s; \
626 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000627#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
628
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000629 const char *format = *p_format;
630 char c = *format++;
631 PyObject *uarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000632
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000633 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000634
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000635 case 'b': { /* unsigned byte -- very short int */
636 char *p = va_arg(*p_va, char *);
637 long ival;
638 if (float_argument_error(arg))
639 return converterr("integer<b>", arg, msgbuf, bufsize);
640 ival = PyLong_AsLong(arg);
641 if (ival == -1 && PyErr_Occurred())
642 return converterr("integer<b>", arg, msgbuf, bufsize);
643 else if (ival < 0) {
644 PyErr_SetString(PyExc_OverflowError,
645 "unsigned byte integer is less than minimum");
646 return converterr("integer<b>", arg, msgbuf, bufsize);
647 }
648 else if (ival > UCHAR_MAX) {
649 PyErr_SetString(PyExc_OverflowError,
650 "unsigned byte integer is greater than maximum");
651 return converterr("integer<b>", arg, msgbuf, bufsize);
652 }
653 else
654 *p = (unsigned char) ival;
655 break;
656 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000657
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000658 case 'B': {/* byte sized bitfield - both signed and unsigned
659 values allowed */
660 char *p = va_arg(*p_va, char *);
661 long ival;
662 if (float_argument_error(arg))
663 return converterr("integer<B>", arg, msgbuf, bufsize);
664 ival = PyLong_AsUnsignedLongMask(arg);
665 if (ival == -1 && PyErr_Occurred())
666 return converterr("integer<B>", arg, msgbuf, bufsize);
667 else
668 *p = (unsigned char) ival;
669 break;
670 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000671
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000672 case 'h': {/* signed short int */
673 short *p = va_arg(*p_va, short *);
674 long ival;
675 if (float_argument_error(arg))
676 return converterr("integer<h>", arg, msgbuf, bufsize);
677 ival = PyLong_AsLong(arg);
678 if (ival == -1 && PyErr_Occurred())
679 return converterr("integer<h>", arg, msgbuf, bufsize);
680 else if (ival < SHRT_MIN) {
681 PyErr_SetString(PyExc_OverflowError,
682 "signed short integer is less than minimum");
683 return converterr("integer<h>", arg, msgbuf, bufsize);
684 }
685 else if (ival > SHRT_MAX) {
686 PyErr_SetString(PyExc_OverflowError,
687 "signed short integer is greater than maximum");
688 return converterr("integer<h>", arg, msgbuf, bufsize);
689 }
690 else
691 *p = (short) ival;
692 break;
693 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000694
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000695 case 'H': { /* short int sized bitfield, both signed and
696 unsigned allowed */
697 unsigned short *p = va_arg(*p_va, unsigned short *);
698 long ival;
699 if (float_argument_error(arg))
700 return converterr("integer<H>", arg, msgbuf, bufsize);
701 ival = PyLong_AsUnsignedLongMask(arg);
702 if (ival == -1 && PyErr_Occurred())
703 return converterr("integer<H>", arg, msgbuf, bufsize);
704 else
705 *p = (unsigned short) ival;
706 break;
707 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000708
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000709 case 'i': {/* signed int */
710 int *p = va_arg(*p_va, int *);
711 long ival;
712 if (float_argument_error(arg))
713 return converterr("integer<i>", arg, msgbuf, bufsize);
714 ival = PyLong_AsLong(arg);
715 if (ival == -1 && PyErr_Occurred())
716 return converterr("integer<i>", arg, msgbuf, bufsize);
717 else if (ival > INT_MAX) {
718 PyErr_SetString(PyExc_OverflowError,
719 "signed integer is greater than maximum");
720 return converterr("integer<i>", arg, msgbuf, bufsize);
721 }
722 else if (ival < INT_MIN) {
723 PyErr_SetString(PyExc_OverflowError,
724 "signed integer is less than minimum");
725 return converterr("integer<i>", arg, msgbuf, bufsize);
726 }
727 else
728 *p = ival;
729 break;
730 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000731
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000732 case 'I': { /* int sized bitfield, both signed and
733 unsigned allowed */
734 unsigned int *p = va_arg(*p_va, unsigned int *);
735 unsigned int ival;
736 if (float_argument_error(arg))
737 return converterr("integer<I>", arg, msgbuf, bufsize);
738 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
739 if (ival == (unsigned int)-1 && PyErr_Occurred())
740 return converterr("integer<I>", arg, msgbuf, bufsize);
741 else
742 *p = ival;
743 break;
744 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000745
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000746 case 'n': /* Py_ssize_t */
747 {
748 PyObject *iobj;
749 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
750 Py_ssize_t ival = -1;
751 if (float_argument_error(arg))
752 return converterr("integer<n>", arg, msgbuf, bufsize);
753 iobj = PyNumber_Index(arg);
754 if (iobj != NULL) {
755 ival = PyLong_AsSsize_t(iobj);
756 Py_DECREF(iobj);
757 }
758 if (ival == -1 && PyErr_Occurred())
759 return converterr("integer<n>", arg, msgbuf, bufsize);
760 *p = ival;
761 break;
762 }
763 case 'l': {/* long int */
764 long *p = va_arg(*p_va, long *);
765 long ival;
766 if (float_argument_error(arg))
767 return converterr("integer<l>", arg, msgbuf, bufsize);
768 ival = PyLong_AsLong(arg);
769 if (ival == -1 && PyErr_Occurred())
770 return converterr("integer<l>", arg, msgbuf, bufsize);
771 else
772 *p = ival;
773 break;
774 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000775
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000776 case 'k': { /* long sized bitfield */
777 unsigned long *p = va_arg(*p_va, unsigned long *);
778 unsigned long ival;
779 if (PyLong_Check(arg))
780 ival = PyLong_AsUnsignedLongMask(arg);
781 else
782 return converterr("integer<k>", arg, msgbuf, bufsize);
783 *p = ival;
784 break;
785 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000786
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000787#ifdef HAVE_LONG_LONG
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000788 case 'L': {/* PY_LONG_LONG */
789 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
790 PY_LONG_LONG ival = PyLong_AsLongLong( arg );
791 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
792 return converterr("long<L>", arg, msgbuf, bufsize);
793 } else {
794 *p = ival;
795 }
796 break;
797 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000798
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000799 case 'K': { /* long long sized bitfield */
800 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
801 unsigned PY_LONG_LONG ival;
802 if (PyLong_Check(arg))
803 ival = PyLong_AsUnsignedLongLongMask(arg);
804 else
805 return converterr("integer<K>", arg, msgbuf, bufsize);
806 *p = ival;
807 break;
808 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000809#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000810
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000811 case 'f': {/* float */
812 float *p = va_arg(*p_va, float *);
813 double dval = PyFloat_AsDouble(arg);
814 if (PyErr_Occurred())
815 return converterr("float<f>", arg, msgbuf, bufsize);
816 else
817 *p = (float) dval;
818 break;
819 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000820
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000821 case 'd': {/* double */
822 double *p = va_arg(*p_va, double *);
823 double dval = PyFloat_AsDouble(arg);
824 if (PyErr_Occurred())
825 return converterr("float<d>", arg, msgbuf, bufsize);
826 else
827 *p = dval;
828 break;
829 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000830
Guido van Rossum530956d1996-07-21 02:27:43 +0000831#ifndef WITHOUT_COMPLEX
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000832 case 'D': {/* complex double */
833 Py_complex *p = va_arg(*p_va, Py_complex *);
834 Py_complex cval;
835 cval = PyComplex_AsCComplex(arg);
836 if (PyErr_Occurred())
837 return converterr("complex<D>", arg, msgbuf, bufsize);
838 else
839 *p = cval;
840 break;
841 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000842#endif /* WITHOUT_COMPLEX */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000843
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000844 case 'c': {/* char */
845 char *p = va_arg(*p_va, char *);
846 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
847 *p = PyBytes_AS_STRING(arg)[0];
848 else
849 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
850 break;
851 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000852
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000853 case 'C': {/* unicode char */
854 int *p = va_arg(*p_va, int *);
855 if (PyUnicode_Check(arg) &&
856 PyUnicode_GET_SIZE(arg) == 1)
857 *p = PyUnicode_AS_UNICODE(arg)[0];
858 else
859 return converterr("a unicode character", arg, msgbuf, bufsize);
860 break;
861 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000862
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000863 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w', 't' codes all
864 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000865
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000866 case 's': {/* text string */
867 if (*format == '*') {
868 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000869
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000870 if (PyUnicode_Check(arg)) {
871 uarg = UNICODE_DEFAULT_ENCODING(arg);
872 if (uarg == NULL)
873 return converterr(CONV_UNICODE,
874 arg, msgbuf, bufsize);
875 PyBuffer_FillInfo(p, arg,
876 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
877 1, 0);
878 }
879 else { /* any buffer-like object */
880 char *buf;
881 if (getbuffer(arg, p, &buf) < 0)
882 return converterr(buf, arg, msgbuf, bufsize);
883 }
884 if (addcleanup(p, freelist, cleanup_buffer)) {
885 return converterr(
886 "(cleanup problem)",
887 arg, msgbuf, bufsize);
888 }
889 format++;
890 } else if (*format == '#') {
891 void **p = (void **)va_arg(*p_va, char **);
892 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000893
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000894 if (PyUnicode_Check(arg)) {
895 uarg = UNICODE_DEFAULT_ENCODING(arg);
896 if (uarg == NULL)
897 return converterr(CONV_UNICODE,
898 arg, msgbuf, bufsize);
899 *p = PyBytes_AS_STRING(uarg);
900 STORE_SIZE(PyBytes_GET_SIZE(uarg));
901 }
902 else { /* any buffer-like object */
903 /* XXX Really? */
904 char *buf;
905 Py_ssize_t count = convertbuffer(arg, p, &buf);
906 if (count < 0)
907 return converterr(buf, arg, msgbuf, bufsize);
908 STORE_SIZE(count);
909 }
910 format++;
911 } else {
912 char **p = va_arg(*p_va, char **);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000913
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000914 if (PyUnicode_Check(arg)) {
915 uarg = UNICODE_DEFAULT_ENCODING(arg);
916 if (uarg == NULL)
917 return converterr(CONV_UNICODE,
918 arg, msgbuf, bufsize);
919 *p = PyBytes_AS_STRING(uarg);
920 }
921 else
922 return converterr("string", arg, msgbuf, bufsize);
923 if ((Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
924 return converterr("string without null bytes",
925 arg, msgbuf, bufsize);
926 }
927 break;
928 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000929
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000930 case 'y': {/* any buffer-like object, but not PyUnicode */
931 void **p = (void **)va_arg(*p_va, char **);
932 char *buf;
933 Py_ssize_t count;
934 if (*format == '*') {
935 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
936 return converterr(buf, arg, msgbuf, bufsize);
937 format++;
938 if (addcleanup(p, freelist, cleanup_buffer)) {
939 return converterr(
940 "(cleanup problem)",
941 arg, msgbuf, bufsize);
942 }
943 break;
944 }
945 count = convertbuffer(arg, p, &buf);
946 if (count < 0)
947 return converterr(buf, arg, msgbuf, bufsize);
948 else if (*format == '#') {
949 FETCH_SIZE;
950 STORE_SIZE(count);
951 format++;
952 }
953 break;
954 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000955
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000956 case 'z': {/* like 's' or 's#', but None is okay, stored as NULL */
957 if (*format == '*') {
958 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000959
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000960 if (arg == Py_None)
961 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
962 else if (PyUnicode_Check(arg)) {
963 uarg = UNICODE_DEFAULT_ENCODING(arg);
964 if (uarg == NULL)
965 return converterr(CONV_UNICODE,
966 arg, msgbuf, bufsize);
967 PyBuffer_FillInfo(p, arg,
968 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
969 1, 0);
970 }
971 else { /* any buffer-like object */
972 char *buf;
973 if (getbuffer(arg, p, &buf) < 0)
974 return converterr(buf, arg, msgbuf, bufsize);
975 }
976 if (addcleanup(p, freelist, cleanup_buffer)) {
977 return converterr(
978 "(cleanup problem)",
979 arg, msgbuf, bufsize);
980 }
981 format++;
982 } else if (*format == '#') { /* any buffer-like object */
983 void **p = (void **)va_arg(*p_va, char **);
984 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000985
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000986 if (arg == Py_None) {
987 *p = 0;
988 STORE_SIZE(0);
989 }
990 else if (PyUnicode_Check(arg)) {
991 uarg = UNICODE_DEFAULT_ENCODING(arg);
992 if (uarg == NULL)
993 return converterr(CONV_UNICODE,
994 arg, msgbuf, bufsize);
995 *p = PyBytes_AS_STRING(uarg);
996 STORE_SIZE(PyBytes_GET_SIZE(uarg));
997 }
998 else { /* any buffer-like object */
999 /* XXX Really? */
1000 char *buf;
1001 Py_ssize_t count = convertbuffer(arg, p, &buf);
1002 if (count < 0)
1003 return converterr(buf, arg, msgbuf, bufsize);
1004 STORE_SIZE(count);
1005 }
1006 format++;
1007 } else {
1008 char **p = va_arg(*p_va, char **);
1009 uarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001010
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001011 if (arg == Py_None)
1012 *p = 0;
1013 else if (PyBytes_Check(arg)) {
1014 /* Enable null byte check below */
1015 uarg = arg;
1016 *p = PyBytes_AS_STRING(arg);
1017 }
1018 else if (PyUnicode_Check(arg)) {
1019 uarg = UNICODE_DEFAULT_ENCODING(arg);
1020 if (uarg == NULL)
1021 return converterr(CONV_UNICODE,
1022 arg, msgbuf, bufsize);
1023 *p = PyBytes_AS_STRING(uarg);
1024 }
1025 else
1026 return converterr("string or None",
1027 arg, msgbuf, bufsize);
1028 if (*format == '#') {
1029 FETCH_SIZE;
1030 assert(0); /* XXX redundant with if-case */
1031 if (arg == Py_None) {
1032 STORE_SIZE(0);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001033 }
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001034 else {
1035 STORE_SIZE(PyBytes_Size(arg));
1036 }
1037 format++;
1038 }
1039 else if (*p != NULL && uarg != NULL &&
1040 (Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
1041 return converterr(
1042 "string without null bytes or None",
1043 arg, msgbuf, bufsize);
1044 }
1045 break;
1046 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001047
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001048 case 'Z': {/* unicode, may be NULL (None) */
1049 if (*format == '#') { /* any buffer-like object */
1050 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1051 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001052
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001053 if (arg == Py_None) {
1054 *p = 0;
1055 STORE_SIZE(0);
1056 }
1057 else if (PyUnicode_Check(arg)) {
1058 *p = PyUnicode_AS_UNICODE(arg);
1059 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1060 }
Victor Stinner55b002f2010-06-08 21:46:32 +00001061 else
1062 return converterr("str or None", arg, msgbuf, bufsize);
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001063 format++;
1064 } else {
1065 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001066
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001067 if (arg == Py_None)
1068 *p = 0;
1069 else if (PyUnicode_Check(arg))
1070 *p = PyUnicode_AS_UNICODE(arg);
1071 else
Victor Stinner55b002f2010-06-08 21:46:32 +00001072 return converterr("str or None", arg, msgbuf, bufsize);
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001073 }
1074 break;
1075 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001076
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001077 case 'e': {/* encoded string */
1078 char **buffer;
1079 const char *encoding;
1080 PyObject *s;
1081 int recode_strings;
1082 Py_ssize_t size;
1083 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001084
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001085 /* Get 'e' parameter: the encoding name */
1086 encoding = (const char *)va_arg(*p_va, const char *);
1087 if (encoding == NULL)
1088 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001089
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001090 /* Get output buffer parameter:
1091 's' (recode all objects via Unicode) or
1092 't' (only recode non-string objects)
1093 */
1094 if (*format == 's')
1095 recode_strings = 1;
1096 else if (*format == 't')
1097 recode_strings = 0;
1098 else
1099 return converterr(
1100 "(unknown parser marker combination)",
1101 arg, msgbuf, bufsize);
1102 buffer = (char **)va_arg(*p_va, char **);
1103 format++;
1104 if (buffer == NULL)
1105 return converterr("(buffer is NULL)",
1106 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001107
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001108 /* Encode object */
1109 if (!recode_strings &&
1110 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1111 s = arg;
1112 Py_INCREF(s);
1113 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1114 return converterr("(AsCharBuffer failed)",
1115 arg, msgbuf, bufsize);
1116 }
1117 else {
1118 PyObject *u;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001119
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001120 /* Convert object to Unicode */
1121 u = PyUnicode_FromObject(arg);
1122 if (u == NULL)
1123 return converterr(
1124 "string or unicode or text buffer",
1125 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001126
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001127 /* Encode object; use default error handling */
1128 s = PyUnicode_AsEncodedString(u,
1129 encoding,
1130 NULL);
1131 Py_DECREF(u);
1132 if (s == NULL)
1133 return converterr("(encoding failed)",
1134 arg, msgbuf, bufsize);
1135 if (!PyBytes_Check(s)) {
1136 Py_DECREF(s);
1137 return converterr(
1138 "(encoder failed to return bytes)",
1139 arg, msgbuf, bufsize);
1140 }
1141 size = PyBytes_GET_SIZE(s);
1142 ptr = PyBytes_AS_STRING(s);
1143 if (ptr == NULL)
1144 ptr = "";
1145 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001146
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001147 /* Write output; output is guaranteed to be 0-terminated */
1148 if (*format == '#') {
1149 /* Using buffer length parameter '#':
1150
1151 - if *buffer is NULL, a new buffer of the
1152 needed size is allocated and the data
1153 copied into it; *buffer is updated to point
1154 to the new buffer; the caller is
1155 responsible for PyMem_Free()ing it after
1156 usage
1157
1158 - if *buffer is not NULL, the data is
1159 copied to *buffer; *buffer_len has to be
1160 set to the size of the buffer on input;
1161 buffer overflow is signalled with an error;
1162 buffer has to provide enough room for the
1163 encoded string plus the trailing 0-byte
1164
1165 - in both cases, *buffer_len is updated to
1166 the size of the buffer /excluding/ the
1167 trailing 0-byte
1168
1169 */
1170 FETCH_SIZE;
1171
1172 format++;
1173 if (q == NULL && q2 == NULL) {
1174 Py_DECREF(s);
1175 return converterr(
1176 "(buffer_len is NULL)",
1177 arg, msgbuf, bufsize);
1178 }
1179 if (*buffer == NULL) {
1180 *buffer = PyMem_NEW(char, size + 1);
1181 if (*buffer == NULL) {
1182 Py_DECREF(s);
1183 return converterr(
1184 "(memory error)",
1185 arg, msgbuf, bufsize);
1186 }
1187 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1188 Py_DECREF(s);
1189 return converterr(
1190 "(cleanup problem)",
1191 arg, msgbuf, bufsize);
1192 }
1193 } else {
1194 if (size + 1 > BUFFER_LEN) {
1195 Py_DECREF(s);
1196 return converterr(
1197 "(buffer overflow)",
1198 arg, msgbuf, bufsize);
1199 }
1200 }
1201 memcpy(*buffer, ptr, size+1);
1202 STORE_SIZE(size);
1203 } else {
1204 /* Using a 0-terminated buffer:
1205
1206 - the encoded string has to be 0-terminated
1207 for this variant to work; if it is not, an
1208 error raised
1209
1210 - a new buffer of the needed size is
1211 allocated and the data copied into it;
1212 *buffer is updated to point to the new
1213 buffer; the caller is responsible for
1214 PyMem_Free()ing it after usage
1215
1216 */
1217 if ((Py_ssize_t)strlen(ptr) != size) {
1218 Py_DECREF(s);
1219 return converterr(
1220 "encoded string without NULL bytes",
1221 arg, msgbuf, bufsize);
1222 }
1223 *buffer = PyMem_NEW(char, size + 1);
1224 if (*buffer == NULL) {
1225 Py_DECREF(s);
1226 return converterr("(memory error)",
1227 arg, msgbuf, bufsize);
1228 }
1229 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1230 Py_DECREF(s);
1231 return converterr("(cleanup problem)",
1232 arg, msgbuf, bufsize);
1233 }
1234 memcpy(*buffer, ptr, size+1);
1235 }
1236 Py_DECREF(s);
1237 break;
1238 }
1239
1240 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1241 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1242 if (!PyUnicode_Check(arg))
1243 return converterr("str", arg, msgbuf, bufsize);
1244 *p = PyUnicode_AS_UNICODE(arg);
1245 if (*format == '#') { /* store pointer and size */
1246 FETCH_SIZE;
1247 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1248 format++;
1249 }
1250 break;
1251 }
1252
1253 case 'S': { /* PyBytes object */
1254 PyObject **p = va_arg(*p_va, PyObject **);
1255 if (PyBytes_Check(arg))
1256 *p = arg;
1257 else
1258 return converterr("bytes", arg, msgbuf, bufsize);
1259 break;
1260 }
1261
1262 case 'Y': { /* PyByteArray object */
1263 PyObject **p = va_arg(*p_va, PyObject **);
1264 if (PyByteArray_Check(arg))
1265 *p = arg;
1266 else
Victor Stinner55b002f2010-06-08 21:46:32 +00001267 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001268 break;
1269 }
1270
1271 case 'U': { /* PyUnicode object */
1272 PyObject **p = va_arg(*p_va, PyObject **);
1273 if (PyUnicode_Check(arg))
1274 *p = arg;
1275 else
1276 return converterr("str", arg, msgbuf, bufsize);
1277 break;
1278 }
1279
1280 case 'O': { /* object */
1281 PyTypeObject *type;
1282 PyObject **p;
1283 if (*format == '!') {
1284 type = va_arg(*p_va, PyTypeObject*);
1285 p = va_arg(*p_va, PyObject **);
1286 format++;
1287 if (PyType_IsSubtype(arg->ob_type, type))
1288 *p = arg;
1289 else
1290 return converterr(type->tp_name, arg, msgbuf, bufsize);
1291
1292 }
1293 else if (*format == '?') {
1294 inquiry pred = va_arg(*p_va, inquiry);
1295 p = va_arg(*p_va, PyObject **);
1296 format++;
1297 if ((*pred)(arg))
1298 *p = arg;
1299 else
1300 return converterr("(unspecified)",
1301 arg, msgbuf, bufsize);
1302
1303 }
1304 else if (*format == '&') {
1305 typedef int (*converter)(PyObject *, void *);
1306 converter convert = va_arg(*p_va, converter);
1307 void *addr = va_arg(*p_va, void *);
1308 int res;
1309 format++;
1310 if (! (res = (*convert)(arg, addr)))
1311 return converterr("(unspecified)",
1312 arg, msgbuf, bufsize);
1313 if (res == Py_CLEANUP_SUPPORTED &&
1314 addcleanup_convert(addr, freelist, convert) == -1)
1315 return converterr("(cleanup problem)",
1316 arg, msgbuf, bufsize);
1317 }
1318 else {
1319 p = va_arg(*p_va, PyObject **);
1320 *p = arg;
1321 }
1322 break;
1323 }
1324
1325
1326 case 'w': { /* memory buffer, read-write access */
1327 void **p = va_arg(*p_va, void **);
1328 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1329 Py_ssize_t count;
1330 int temp=-1;
1331 Py_buffer view;
1332
1333 if (pb && pb->bf_releasebuffer && *format != '*')
1334 /* Buffer must be released, yet caller does not use
1335 the Py_buffer protocol. */
1336 return converterr("pinned buffer", arg, msgbuf, bufsize);
1337
1338
1339 if (pb && pb->bf_getbuffer && *format == '*') {
1340 /* Caller is interested in Py_buffer, and the object
1341 supports it directly. */
1342 format++;
1343 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1344 PyErr_Clear();
1345 return converterr("read-write buffer", arg, msgbuf, bufsize);
1346 }
1347 if (addcleanup(p, freelist, cleanup_buffer)) {
1348 return converterr(
1349 "(cleanup problem)",
1350 arg, msgbuf, bufsize);
1351 }
1352 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C'))
1353 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1354 break;
1355 }
1356
1357 /* Here we have processed w*, only w and w# remain. */
1358 if (pb == NULL ||
1359 pb->bf_getbuffer == NULL ||
1360 ((temp = PyObject_GetBuffer(arg, &view,
1361 PyBUF_SIMPLE)) != 0) ||
1362 view.readonly == 1) {
1363 if (temp==0) {
1364 PyBuffer_Release(&view);
1365 }
1366 return converterr("single-segment read-write buffer",
1367 arg, msgbuf, bufsize);
1368 }
1369
1370 if ((count = view.len) < 0)
1371 return converterr("(unspecified)", arg, msgbuf, bufsize);
1372 *p = view.buf;
1373 if (*format == '#') {
1374 FETCH_SIZE;
1375 STORE_SIZE(count);
1376 format++;
1377 }
1378 break;
1379 }
1380
1381 /*TEO: This can be eliminated --- here only for backward
1382 compatibility */
1383 case 't': { /* 8-bit character buffer, read-only access */
1384 char **p = va_arg(*p_va, char **);
1385 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1386 Py_ssize_t count;
1387 Py_buffer view;
1388
1389 if (*format++ != '#')
1390 return converterr(
1391 "invalid use of 't' format character",
1392 arg, msgbuf, bufsize);
1393 if (pb == NULL || pb->bf_getbuffer == NULL)
1394 return converterr(
1395 "bytes or read-only character buffer",
1396 arg, msgbuf, bufsize);
Victor Stinner17479992010-06-24 23:06:25 +00001397 if (pb->bf_releasebuffer)
1398 return converterr(
1399 "string or pinned buffer",
1400 arg, msgbuf, bufsize);
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001401
1402 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0)
1403 return converterr("string or single-segment read-only buffer",
1404 arg, msgbuf, bufsize);
1405
1406 count = view.len;
1407 *p = view.buf;
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001408
1409 PyBuffer_Release(&view);
1410
1411 if (count < 0)
1412 return converterr("(unspecified)", arg, msgbuf, bufsize);
1413 {
1414 FETCH_SIZE;
1415 STORE_SIZE(count);
1416 }
1417 break;
1418 }
1419
1420 default:
1421 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
1422
1423 }
1424
1425 *p_format = format;
1426 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001427}
Guido van Rossumaa354651996-08-19 19:32:04 +00001428
Martin v. Löwis18e16552006-02-15 17:27:45 +00001429static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001430convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001431{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001432 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1433 Py_ssize_t count;
1434 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001435
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001436 *errmsg = NULL;
1437 *p = NULL;
1438 if (pb == NULL ||
1439 pb->bf_getbuffer == NULL ||
1440 pb->bf_releasebuffer != NULL) {
1441 *errmsg = "bytes or read-only buffer";
1442 return -1;
1443 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001444
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001445 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0) {
1446 *errmsg = "bytes or single-segment read-only buffer";
1447 return -1;
1448 }
1449 count = view.len;
1450 *p = view.buf;
1451 PyBuffer_Release(&view);
1452 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001453}
Guido van Rossumaa354651996-08-19 19:32:04 +00001454
Martin v. Löwis423be952008-08-13 15:53:07 +00001455/* XXX for 3.x, getbuffer and convertbuffer can probably
1456 be merged again. */
1457static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001458getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001459{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001460 void *buf;
1461 Py_ssize_t count;
1462 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1463 if (pb == NULL) {
1464 *errmsg = "bytes or buffer";
1465 return -1;
1466 }
1467 if (pb->bf_getbuffer) {
1468 if (PyObject_GetBuffer(arg, view, 0) < 0) {
1469 *errmsg = "convertible to a buffer";
1470 return -1;
1471 }
1472 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner17479992010-06-24 23:06:25 +00001473 PyBuffer_Release(view);
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001474 *errmsg = "contiguous buffer";
1475 return -1;
1476 }
1477 return 0;
1478 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001479
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001480 count = convertbuffer(arg, &buf, errmsg);
1481 if (count < 0) {
1482 *errmsg = "convertible to a buffer";
1483 return count;
1484 }
1485 PyBuffer_FillInfo(view, NULL, buf, count, 1, 0);
1486 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001487}
1488
Guido van Rossumaa354651996-08-19 19:32:04 +00001489/* Support for keyword arguments donated by
1490 Geoff Philbrick <philbric@delphi.hks.com> */
1491
Tim Petersf8cd3e82001-10-27 04:26:57 +00001492/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001493int
1494PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001495 PyObject *keywords,
1496 const char *format,
1497 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001498{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001499 int retval;
1500 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001501
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +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 }
Tim Peters45772cd2001-10-27 03:58:40 +00001510
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001511 va_start(va, kwlist);
1512 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1513 va_end(va);
1514 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001515}
1516
1517int
1518_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001519 PyObject *keywords,
1520 const char *format,
1521 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001522{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001523 int retval;
1524 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001525
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001526 if ((args == NULL || !PyTuple_Check(args)) ||
1527 (keywords != NULL && !PyDict_Check(keywords)) ||
1528 format == NULL ||
1529 kwlist == NULL)
1530 {
1531 PyErr_BadInternalCall();
1532 return 0;
1533 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001534
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001535 va_start(va, kwlist);
1536 retval = vgetargskeywords(args, keywords, format,
1537 kwlist, &va, FLAG_SIZE_T);
1538 va_end(va);
1539 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001540}
1541
1542
Brett Cannon711e7d92004-07-10 22:20:32 +00001543int
1544PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001545 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001546 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001547 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001548{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001549 int retval;
1550 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001551
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001552 if ((args == NULL || !PyTuple_Check(args)) ||
1553 (keywords != NULL && !PyDict_Check(keywords)) ||
1554 format == NULL ||
1555 kwlist == NULL)
1556 {
1557 PyErr_BadInternalCall();
1558 return 0;
1559 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001560
1561#ifdef VA_LIST_IS_ARRAY
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001562 memcpy(lva, va, sizeof(va_list));
Brett Cannon711e7d92004-07-10 22:20:32 +00001563#else
1564#ifdef __va_copy
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001565 __va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001566#else
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001567 lva = va;
Brett Cannon711e7d92004-07-10 22:20:32 +00001568#endif
1569#endif
1570
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001571 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1572 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001573}
1574
1575int
1576_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001577 PyObject *keywords,
1578 const char *format,
1579 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001580{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001581 int retval;
1582 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001583
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001584 if ((args == NULL || !PyTuple_Check(args)) ||
1585 (keywords != NULL && !PyDict_Check(keywords)) ||
1586 format == NULL ||
1587 kwlist == NULL)
1588 {
1589 PyErr_BadInternalCall();
1590 return 0;
1591 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001592
1593#ifdef VA_LIST_IS_ARRAY
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001594 memcpy(lva, va, sizeof(va_list));
Martin v. Löwis18e16552006-02-15 17:27:45 +00001595#else
1596#ifdef __va_copy
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001597 __va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001598#else
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001599 lva = va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001600#endif
1601#endif
1602
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001603 retval = vgetargskeywords(args, keywords, format,
1604 kwlist, &lva, FLAG_SIZE_T);
1605 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001606}
1607
Christian Heimes380f7f22008-02-28 11:19:05 +00001608#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001609
Guido van Rossumaa354651996-08-19 19:32:04 +00001610static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001611vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001612 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001613{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001614 char msgbuf[512];
1615 int levels[32];
1616 const char *fname, *msg, *custom_msg, *keyword;
1617 int min = INT_MAX;
1618 int i, len, nargs, nkeywords;
1619 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001620
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001621 assert(args != NULL && PyTuple_Check(args));
1622 assert(keywords == NULL || PyDict_Check(keywords));
1623 assert(format != NULL);
1624 assert(kwlist != NULL);
1625 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001626
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001627 /* grab the function name or custom error msg first (mutually exclusive) */
1628 fname = strchr(format, ':');
1629 if (fname) {
1630 fname++;
1631 custom_msg = NULL;
1632 }
1633 else {
1634 custom_msg = strchr(format,';');
1635 if (custom_msg)
1636 custom_msg++;
1637 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001638
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001639 /* scan kwlist and get greatest possible nbr of args */
1640 for (len=0; kwlist[len]; len++)
1641 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001642
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001643 nargs = PyTuple_GET_SIZE(args);
1644 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1645 if (nargs + nkeywords > len) {
1646 PyErr_Format(PyExc_TypeError, "%s%s takes at most %d "
1647 "argument%s (%d given)",
1648 (fname == NULL) ? "function" : fname,
1649 (fname == NULL) ? "" : "()",
1650 len,
1651 (len == 1) ? "" : "s",
1652 nargs + nkeywords);
1653 return 0;
1654 }
Tim Petersc2f01122001-10-27 07:25:06 +00001655
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001656 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1657 for (i = 0; i < len; i++) {
1658 keyword = kwlist[i];
1659 if (*format == '|') {
1660 min = i;
1661 format++;
1662 }
1663 if (IS_END_OF_FORMAT(*format)) {
1664 PyErr_Format(PyExc_RuntimeError,
1665 "More keyword list entries (%d) than "
1666 "format specifiers (%d)", len, i);
1667 return cleanreturn(0, freelist);
1668 }
1669 current_arg = NULL;
1670 if (nkeywords) {
1671 current_arg = PyDict_GetItemString(keywords, keyword);
1672 }
1673 if (current_arg) {
1674 --nkeywords;
1675 if (i < nargs) {
1676 /* arg present in tuple and in dict */
1677 PyErr_Format(PyExc_TypeError,
1678 "Argument given by name ('%s') "
1679 "and position (%d)",
1680 keyword, i+1);
1681 return cleanreturn(0, freelist);
1682 }
1683 }
1684 else if (nkeywords && PyErr_Occurred())
1685 return cleanreturn(0, freelist);
1686 else if (i < nargs)
1687 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimes380f7f22008-02-28 11:19:05 +00001688
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001689 if (current_arg) {
1690 msg = convertitem(current_arg, &format, p_va, flags,
1691 levels, msgbuf, sizeof(msgbuf), &freelist);
1692 if (msg) {
1693 seterror(i+1, msg, levels, fname, custom_msg);
1694 return cleanreturn(0, freelist);
1695 }
1696 continue;
1697 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001698
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001699 if (i < min) {
1700 PyErr_Format(PyExc_TypeError, "Required argument "
1701 "'%s' (pos %d) not found",
1702 keyword, i+1);
1703 return cleanreturn(0, freelist);
1704 }
1705 /* current code reports success when all required args
1706 * fulfilled and no keyword args left, with no further
1707 * validation. XXX Maybe skip this in debug build ?
1708 */
1709 if (!nkeywords)
1710 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001711
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001712 /* We are into optional args, skip thru to any remaining
1713 * keyword args */
1714 msg = skipitem(&format, p_va, flags);
1715 if (msg) {
1716 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1717 format);
1718 return cleanreturn(0, freelist);
1719 }
1720 }
Tim Petersb054be42001-10-27 05:07:41 +00001721
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001722 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
1723 PyErr_Format(PyExc_RuntimeError,
1724 "more argument specifiers than keyword list entries "
1725 "(remaining format:'%s')", format);
1726 return cleanreturn(0, freelist);
1727 }
Tim Petersc2f01122001-10-27 07:25:06 +00001728
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001729 /* make sure there are no extraneous keyword arguments */
1730 if (nkeywords > 0) {
1731 PyObject *key, *value;
1732 Py_ssize_t pos = 0;
1733 while (PyDict_Next(keywords, &pos, &key, &value)) {
1734 int match = 0;
1735 char *ks;
1736 if (!PyUnicode_Check(key)) {
1737 PyErr_SetString(PyExc_TypeError,
1738 "keywords must be strings");
1739 return cleanreturn(0, freelist);
1740 }
1741 ks = _PyUnicode_AsString(key);
1742 for (i = 0; i < len; i++) {
1743 if (!strcmp(ks, kwlist[i])) {
1744 match = 1;
1745 break;
1746 }
1747 }
1748 if (!match) {
1749 PyErr_Format(PyExc_TypeError,
1750 "'%s' is an invalid keyword "
1751 "argument for this function",
1752 ks);
1753 return cleanreturn(0, freelist);
1754 }
1755 }
1756 }
1757
1758 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001759}
1760
1761
1762static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001763skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001764{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001765 const char *format = *p_format;
1766 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001767
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001768 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001769
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001770 /* simple codes
1771 * The individual types (second arg of va_arg) are irrelevant */
Georg Brandl6dd14612005-09-14 19:29:53 +00001772
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001773 case 'b': /* byte -- very short int */
1774 case 'B': /* byte as bitfield */
1775 case 'h': /* short int */
1776 case 'H': /* short int as bitfield */
1777 case 'i': /* int */
1778 case 'I': /* int sized bitfield */
1779 case 'l': /* long int */
1780 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001781#ifdef HAVE_LONG_LONG
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001782 case 'L': /* PY_LONG_LONG */
1783 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001784#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001785 case 'f': /* float */
1786 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001787#ifndef WITHOUT_COMPLEX
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001788 case 'D': /* complex double */
Georg Brandl6dd14612005-09-14 19:29:53 +00001789#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001790 case 'c': /* char */
1791 case 'C': /* unicode char */
1792 {
1793 (void) va_arg(*p_va, void *);
1794 break;
1795 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001796
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001797 case 'n': /* Py_ssize_t */
1798 {
1799 (void) va_arg(*p_va, Py_ssize_t *);
1800 break;
1801 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001802
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001803 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001804
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001805 case 'e': /* string with encoding */
1806 {
1807 (void) va_arg(*p_va, const char *);
1808 if (!(*format == 's' || *format == 't'))
1809 /* after 'e', only 's' and 't' is allowed */
1810 goto err;
1811 format++;
1812 /* explicit fallthrough to string cases */
1813 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001814
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001815 case 's': /* string */
1816 case 'z': /* string or None */
1817 case 'y': /* bytes */
1818 case 'u': /* unicode string */
1819 case 't': /* buffer, read-only */
1820 case 'w': /* buffer, read-write */
1821 {
1822 (void) va_arg(*p_va, char **);
1823 if (*format == '#') {
1824 if (flags & FLAG_SIZE_T)
1825 (void) va_arg(*p_va, Py_ssize_t *);
1826 else
1827 (void) va_arg(*p_va, int *);
1828 format++;
1829 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1830 format++;
1831 }
1832 break;
1833 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001834
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001835 /* object codes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001836
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001837 case 'S': /* string object */
1838 case 'Y': /* string object */
1839 case 'U': /* unicode string object */
1840 {
1841 (void) va_arg(*p_va, PyObject **);
1842 break;
1843 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001844
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001845 case 'O': /* object */
1846 {
1847 if (*format == '!') {
1848 format++;
1849 (void) va_arg(*p_va, PyTypeObject*);
1850 (void) va_arg(*p_va, PyObject **);
1851 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001852#if 0
1853/* I don't know what this is for */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001854 else if (*format == '?') {
1855 inquiry pred = va_arg(*p_va, inquiry);
1856 format++;
1857 if ((*pred)(arg)) {
1858 (void) va_arg(*p_va, PyObject **);
1859 }
1860 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001861#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001862 else if (*format == '&') {
1863 typedef int (*converter)(PyObject *, void *);
1864 (void) va_arg(*p_va, converter);
1865 (void) va_arg(*p_va, void *);
1866 format++;
1867 }
1868 else {
1869 (void) va_arg(*p_va, PyObject **);
1870 }
1871 break;
1872 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001873
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001874 case '(': /* bypass tuple, not handled at all previously */
1875 {
1876 char *msg;
1877 for (;;) {
1878 if (*format==')')
1879 break;
1880 if (IS_END_OF_FORMAT(*format))
1881 return "Unmatched left paren in format "
1882 "string";
1883 msg = skipitem(&format, p_va, flags);
1884 if (msg)
1885 return msg;
1886 }
1887 format++;
1888 break;
1889 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001890
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001891 case ')':
1892 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00001893
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001894 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001895err:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001896 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001897
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001898 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001899
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001900 *p_format = format;
1901 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001902}
Fred Drakee4616e62001-10-23 21:09:29 +00001903
1904
1905int
Martin v. Löwis76246742006-03-01 04:06:10 +00001906PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001907{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001908 Py_ssize_t i, l;
1909 PyObject **o;
1910 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001911
1912#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001913 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001914#else
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001915 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001916#endif
1917
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001918 assert(min >= 0);
1919 assert(min <= max);
1920 if (!PyTuple_Check(args)) {
1921 PyErr_SetString(PyExc_SystemError,
1922 "PyArg_UnpackTuple() argument list is not a tuple");
1923 return 0;
1924 }
1925 l = PyTuple_GET_SIZE(args);
1926 if (l < min) {
1927 if (name != NULL)
1928 PyErr_Format(
1929 PyExc_TypeError,
1930 "%s expected %s%zd arguments, got %zd",
1931 name, (min == max ? "" : "at least "), min, l);
1932 else
1933 PyErr_Format(
1934 PyExc_TypeError,
1935 "unpacked tuple should have %s%zd elements,"
1936 " but has %zd",
1937 (min == max ? "" : "at least "), min, l);
1938 va_end(vargs);
1939 return 0;
1940 }
1941 if (l > max) {
1942 if (name != NULL)
1943 PyErr_Format(
1944 PyExc_TypeError,
1945 "%s expected %s%zd arguments, got %zd",
1946 name, (min == max ? "" : "at most "), max, l);
1947 else
1948 PyErr_Format(
1949 PyExc_TypeError,
1950 "unpacked tuple should have %s%zd elements,"
1951 " but has %zd",
1952 (min == max ? "" : "at most "), max, l);
1953 va_end(vargs);
1954 return 0;
1955 }
1956 for (i = 0; i < l; i++) {
1957 o = va_arg(vargs, PyObject **);
1958 *o = PyTuple_GET_ITEM(args, i);
1959 }
1960 va_end(vargs);
1961 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001962}
Georg Brandl02c42872005-08-26 06:42:30 +00001963
1964
1965/* For type constructors that don't take keyword args
1966 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001967 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001968 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001969 */
1970int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001971_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001972{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001973 if (kw == NULL)
1974 return 1;
1975 if (!PyDict_CheckExact(kw)) {
1976 PyErr_BadInternalCall();
1977 return 0;
1978 }
1979 if (PyDict_Size(kw) == 0)
1980 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001981
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001982 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1983 funcname);
1984 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001985}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001986#ifdef __cplusplus
1987};
1988#endif