blob: b4b5db283c69e3389ac4216b9a9ee6b7a4e94a0d [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 Pitrouf95a1b32010-05-09 15:52:27 +000017 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000018int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +000056 int retval;
57 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +000068 int retval;
69 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000070
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +000081 int retval;
82 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +000093 int retval;
94 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000095
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +0000106 va_list lva;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000107
108#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +0000112 __va_copy(lva, va);
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000113#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +0000124 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000125
126#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000127 memcpy(lva, va, sizeof(va_list));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000128#else
129#ifdef __va_copy
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000130 __va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000131#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000132 lva = va;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000133#endif
134#endif
135
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +0000167 PyObject *cobj;
168 const char *name;
Benjamin Petersonb173f782009-05-05 22:31:58 +0000169
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +0000270 assert(compat || (args != (PyObject*)NULL));
271 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000272
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +0000315 if (level != 0)
316 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000318 if (min < 0)
319 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000320
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000321 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +0000363 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +0000412 char buf[512];
413 int i;
414 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000415
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +0000544 char *msg;
545 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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 Pitrouf95a1b32010-05-09 15:52:27 +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
Mark Dickinsonde604012010-01-01 19:27:32 +0000585/* explicitly check for float arguments when integers are expected. For now
586 * signal a warning. Returns true if an exception was raised. */
587static int
588float_argument_warning(PyObject *arg)
589{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000590 if (PyFloat_Check(arg) &&
591 PyErr_Warn(PyExc_DeprecationWarning,
592 "integer argument expected, got float" ))
593 return 1;
594 else
595 return 0;
Mark Dickinsonde604012010-01-01 19:27:32 +0000596}
597
Guido van Rossum45aecf42006-03-15 04:58:47 +0000598/* Explicitly check for float arguments when integers are expected.
599 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000600static int
601float_argument_error(PyObject *arg)
602{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000603 if (PyFloat_Check(arg)) {
604 PyErr_SetString(PyExc_TypeError,
605 "integer argument expected, got float" );
606 return 1;
607 }
608 else
609 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000610}
611
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000612/* Convert a non-tuple argument. Return NULL if conversion went OK,
613 or a string with a message describing the failure. The message is
614 formatted as "must be <desired type>, not <actual type>".
615 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000616 Don't call if a tuple is expected.
617
618 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000619*/
620
621static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000622convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000623 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000624{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 /* For # codes */
626#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
627 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
628 else q=va_arg(*p_va, int*);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000629#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
630#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
631
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000632 const char *format = *p_format;
633 char c = *format++;
634 PyObject *uarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000635
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000636 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000638 case 'b': { /* unsigned byte -- very short int */
639 char *p = va_arg(*p_va, char *);
640 long ival;
641 if (float_argument_error(arg))
642 return converterr("integer<b>", arg, msgbuf, bufsize);
643 ival = PyLong_AsLong(arg);
644 if (ival == -1 && PyErr_Occurred())
645 return converterr("integer<b>", arg, msgbuf, bufsize);
646 else if (ival < 0) {
647 PyErr_SetString(PyExc_OverflowError,
648 "unsigned byte integer is less than minimum");
649 return converterr("integer<b>", arg, msgbuf, bufsize);
650 }
651 else if (ival > UCHAR_MAX) {
652 PyErr_SetString(PyExc_OverflowError,
653 "unsigned byte integer is greater than maximum");
654 return converterr("integer<b>", arg, msgbuf, bufsize);
655 }
656 else
657 *p = (unsigned char) ival;
658 break;
659 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 case 'B': {/* byte sized bitfield - both signed and unsigned
662 values allowed */
663 char *p = va_arg(*p_va, char *);
664 long ival;
665 if (float_argument_error(arg))
666 return converterr("integer<B>", arg, msgbuf, bufsize);
667 ival = PyLong_AsUnsignedLongMask(arg);
668 if (ival == -1 && PyErr_Occurred())
669 return converterr("integer<B>", arg, msgbuf, bufsize);
670 else
671 *p = (unsigned char) ival;
672 break;
673 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 case 'h': {/* signed short int */
676 short *p = va_arg(*p_va, short *);
677 long ival;
678 if (float_argument_error(arg))
679 return converterr("integer<h>", arg, msgbuf, bufsize);
680 ival = PyLong_AsLong(arg);
681 if (ival == -1 && PyErr_Occurred())
682 return converterr("integer<h>", arg, msgbuf, bufsize);
683 else if (ival < SHRT_MIN) {
684 PyErr_SetString(PyExc_OverflowError,
685 "signed short integer is less than minimum");
686 return converterr("integer<h>", arg, msgbuf, bufsize);
687 }
688 else if (ival > SHRT_MAX) {
689 PyErr_SetString(PyExc_OverflowError,
690 "signed short integer is greater than maximum");
691 return converterr("integer<h>", arg, msgbuf, bufsize);
692 }
693 else
694 *p = (short) ival;
695 break;
696 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000697
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000698 case 'H': { /* short int sized bitfield, both signed and
699 unsigned allowed */
700 unsigned short *p = va_arg(*p_va, unsigned short *);
701 long ival;
702 if (float_argument_error(arg))
703 return converterr("integer<H>", arg, msgbuf, bufsize);
704 ival = PyLong_AsUnsignedLongMask(arg);
705 if (ival == -1 && PyErr_Occurred())
706 return converterr("integer<H>", arg, msgbuf, bufsize);
707 else
708 *p = (unsigned short) ival;
709 break;
710 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000711
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000712 case 'i': {/* signed int */
713 int *p = va_arg(*p_va, int *);
714 long ival;
715 if (float_argument_error(arg))
716 return converterr("integer<i>", arg, msgbuf, bufsize);
717 ival = PyLong_AsLong(arg);
718 if (ival == -1 && PyErr_Occurred())
719 return converterr("integer<i>", arg, msgbuf, bufsize);
720 else if (ival > INT_MAX) {
721 PyErr_SetString(PyExc_OverflowError,
722 "signed integer is greater than maximum");
723 return converterr("integer<i>", arg, msgbuf, bufsize);
724 }
725 else if (ival < INT_MIN) {
726 PyErr_SetString(PyExc_OverflowError,
727 "signed integer is less than minimum");
728 return converterr("integer<i>", arg, msgbuf, bufsize);
729 }
730 else
731 *p = ival;
732 break;
733 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000734
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 case 'I': { /* int sized bitfield, both signed and
736 unsigned allowed */
737 unsigned int *p = va_arg(*p_va, unsigned int *);
738 unsigned int ival;
739 if (float_argument_error(arg))
740 return converterr("integer<I>", arg, msgbuf, bufsize);
741 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
742 if (ival == (unsigned int)-1 && PyErr_Occurred())
743 return converterr("integer<I>", arg, msgbuf, bufsize);
744 else
745 *p = ival;
746 break;
747 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000748
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000749 case 'n': /* Py_ssize_t */
750 {
751 PyObject *iobj;
752 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
753 Py_ssize_t ival = -1;
754 if (float_argument_error(arg))
755 return converterr("integer<n>", arg, msgbuf, bufsize);
756 iobj = PyNumber_Index(arg);
757 if (iobj != NULL) {
758 ival = PyLong_AsSsize_t(iobj);
759 Py_DECREF(iobj);
760 }
761 if (ival == -1 && PyErr_Occurred())
762 return converterr("integer<n>", arg, msgbuf, bufsize);
763 *p = ival;
764 break;
765 }
766 case 'l': {/* long int */
767 long *p = va_arg(*p_va, long *);
768 long ival;
769 if (float_argument_error(arg))
770 return converterr("integer<l>", arg, msgbuf, bufsize);
771 ival = PyLong_AsLong(arg);
772 if (ival == -1 && PyErr_Occurred())
773 return converterr("integer<l>", arg, msgbuf, bufsize);
774 else
775 *p = ival;
776 break;
777 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000778
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000779 case 'k': { /* long sized bitfield */
780 unsigned long *p = va_arg(*p_va, unsigned long *);
781 unsigned long ival;
782 if (PyLong_Check(arg))
783 ival = PyLong_AsUnsignedLongMask(arg);
784 else
785 return converterr("integer<k>", arg, msgbuf, bufsize);
786 *p = ival;
787 break;
788 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000789
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000790#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000791 case 'L': {/* PY_LONG_LONG */
792 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
793 PY_LONG_LONG ival;
794 if (float_argument_warning(arg))
795 return converterr("long<L>", arg, msgbuf, bufsize);
796 ival = PyLong_AsLongLong(arg);
797 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
798 return converterr("long<L>", arg, msgbuf, bufsize);
799 } else {
800 *p = ival;
801 }
802 break;
803 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000804
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000805 case 'K': { /* long long sized bitfield */
806 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
807 unsigned PY_LONG_LONG ival;
808 if (PyLong_Check(arg))
809 ival = PyLong_AsUnsignedLongLongMask(arg);
810 else
811 return converterr("integer<K>", arg, msgbuf, bufsize);
812 *p = ival;
813 break;
814 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000815#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000816
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000817 case 'f': {/* float */
818 float *p = va_arg(*p_va, float *);
819 double dval = PyFloat_AsDouble(arg);
820 if (PyErr_Occurred())
821 return converterr("float<f>", arg, msgbuf, bufsize);
822 else
823 *p = (float) dval;
824 break;
825 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000826
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000827 case 'd': {/* double */
828 double *p = va_arg(*p_va, double *);
829 double dval = PyFloat_AsDouble(arg);
830 if (PyErr_Occurred())
831 return converterr("float<d>", arg, msgbuf, bufsize);
832 else
833 *p = dval;
834 break;
835 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000836
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000837 case 'D': {/* complex double */
838 Py_complex *p = va_arg(*p_va, Py_complex *);
839 Py_complex cval;
840 cval = PyComplex_AsCComplex(arg);
841 if (PyErr_Occurred())
842 return converterr("complex<D>", arg, msgbuf, bufsize);
843 else
844 *p = cval;
845 break;
846 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 case 'c': {/* char */
849 char *p = va_arg(*p_va, char *);
850 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
851 *p = PyBytes_AS_STRING(arg)[0];
852 else
853 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
854 break;
855 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000856
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 case 'C': {/* unicode char */
858 int *p = va_arg(*p_va, int *);
859 if (PyUnicode_Check(arg) &&
860 PyUnicode_GET_SIZE(arg) == 1)
861 *p = PyUnicode_AS_UNICODE(arg)[0];
862 else
863 return converterr("a unicode character", arg, msgbuf, bufsize);
864 break;
865 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000866
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w', 't' codes all
868 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000869
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 case 's': {/* text string */
871 if (*format == '*') {
872 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000873
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000874 if (PyUnicode_Check(arg)) {
875 uarg = UNICODE_DEFAULT_ENCODING(arg);
876 if (uarg == NULL)
877 return converterr(CONV_UNICODE,
878 arg, msgbuf, bufsize);
879 PyBuffer_FillInfo(p, arg,
880 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
881 1, 0);
882 }
883 else { /* any buffer-like object */
884 char *buf;
885 if (getbuffer(arg, p, &buf) < 0)
886 return converterr(buf, arg, msgbuf, bufsize);
887 }
888 if (addcleanup(p, freelist, cleanup_buffer)) {
889 return converterr(
890 "(cleanup problem)",
891 arg, msgbuf, bufsize);
892 }
893 format++;
894 } else if (*format == '#') {
895 void **p = (void **)va_arg(*p_va, char **);
896 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000897
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000898 if (PyUnicode_Check(arg)) {
899 uarg = UNICODE_DEFAULT_ENCODING(arg);
900 if (uarg == NULL)
901 return converterr(CONV_UNICODE,
902 arg, msgbuf, bufsize);
903 *p = PyBytes_AS_STRING(uarg);
904 STORE_SIZE(PyBytes_GET_SIZE(uarg));
905 }
906 else { /* any buffer-like object */
907 /* XXX Really? */
908 char *buf;
909 Py_ssize_t count = convertbuffer(arg, p, &buf);
910 if (count < 0)
911 return converterr(buf, arg, msgbuf, bufsize);
912 STORE_SIZE(count);
913 }
914 format++;
915 } else {
916 char **p = va_arg(*p_va, char **);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 if (PyUnicode_Check(arg)) {
919 uarg = UNICODE_DEFAULT_ENCODING(arg);
920 if (uarg == NULL)
921 return converterr(CONV_UNICODE,
922 arg, msgbuf, bufsize);
923 *p = PyBytes_AS_STRING(uarg);
924 }
925 else
926 return converterr("string", arg, msgbuf, bufsize);
927 if ((Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
928 return converterr("string without null bytes",
929 arg, msgbuf, bufsize);
930 }
931 break;
932 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000933
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 case 'y': {/* any buffer-like object, but not PyUnicode */
935 void **p = (void **)va_arg(*p_va, char **);
936 char *buf;
937 Py_ssize_t count;
938 if (*format == '*') {
939 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
940 return converterr(buf, arg, msgbuf, bufsize);
941 format++;
942 if (addcleanup(p, freelist, cleanup_buffer)) {
943 return converterr(
944 "(cleanup problem)",
945 arg, msgbuf, bufsize);
946 }
947 break;
948 }
949 count = convertbuffer(arg, p, &buf);
950 if (count < 0)
951 return converterr(buf, arg, msgbuf, bufsize);
952 else if (*format == '#') {
953 FETCH_SIZE;
954 STORE_SIZE(count);
955 format++;
956 }
957 break;
958 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000959
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 case 'z': {/* like 's' or 's#', but None is okay, stored as NULL */
961 if (*format == '*') {
962 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000963
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000964 if (arg == Py_None)
965 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
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 PyBuffer_FillInfo(p, arg,
972 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
973 1, 0);
974 }
975 else { /* any buffer-like object */
976 char *buf;
977 if (getbuffer(arg, p, &buf) < 0)
978 return converterr(buf, arg, msgbuf, bufsize);
979 }
980 if (addcleanup(p, freelist, cleanup_buffer)) {
981 return converterr(
982 "(cleanup problem)",
983 arg, msgbuf, bufsize);
984 }
985 format++;
986 } else if (*format == '#') { /* any buffer-like object */
987 void **p = (void **)va_arg(*p_va, char **);
988 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000989
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000990 if (arg == Py_None) {
991 *p = 0;
992 STORE_SIZE(0);
993 }
994 else if (PyUnicode_Check(arg)) {
995 uarg = UNICODE_DEFAULT_ENCODING(arg);
996 if (uarg == NULL)
997 return converterr(CONV_UNICODE,
998 arg, msgbuf, bufsize);
999 *p = PyBytes_AS_STRING(uarg);
1000 STORE_SIZE(PyBytes_GET_SIZE(uarg));
1001 }
1002 else { /* any buffer-like object */
1003 /* XXX Really? */
1004 char *buf;
1005 Py_ssize_t count = convertbuffer(arg, p, &buf);
1006 if (count < 0)
1007 return converterr(buf, arg, msgbuf, bufsize);
1008 STORE_SIZE(count);
1009 }
1010 format++;
1011 } else {
1012 char **p = va_arg(*p_va, char **);
1013 uarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001015 if (arg == Py_None)
1016 *p = 0;
1017 else if (PyBytes_Check(arg)) {
1018 /* Enable null byte check below */
1019 uarg = arg;
1020 *p = PyBytes_AS_STRING(arg);
1021 }
1022 else if (PyUnicode_Check(arg)) {
1023 uarg = UNICODE_DEFAULT_ENCODING(arg);
1024 if (uarg == NULL)
1025 return converterr(CONV_UNICODE,
1026 arg, msgbuf, bufsize);
1027 *p = PyBytes_AS_STRING(uarg);
1028 }
1029 else
1030 return converterr("string or None",
1031 arg, msgbuf, bufsize);
Victor Stinner43fb0092010-05-29 00:13:06 +00001032 if (*p != NULL && uarg != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001033 (Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
1034 return converterr(
1035 "string without null bytes or None",
1036 arg, msgbuf, bufsize);
1037 }
1038 break;
1039 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001040
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001041 case 'Z': {/* unicode, may be NULL (None) */
1042 if (*format == '#') { /* any buffer-like object */
1043 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1044 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 if (arg == Py_None) {
1047 *p = 0;
1048 STORE_SIZE(0);
1049 }
1050 else if (PyUnicode_Check(arg)) {
1051 *p = PyUnicode_AS_UNICODE(arg);
1052 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1053 }
1054 format++;
1055 } else {
1056 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001057
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001058 if (arg == Py_None)
1059 *p = 0;
1060 else if (PyUnicode_Check(arg))
1061 *p = PyUnicode_AS_UNICODE(arg);
1062 else
1063 return converterr("string or None",
1064 arg, msgbuf, bufsize);
1065 }
1066 break;
1067 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001068
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001069 case 'e': {/* encoded string */
1070 char **buffer;
1071 const char *encoding;
1072 PyObject *s;
1073 int recode_strings;
1074 Py_ssize_t size;
1075 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001076
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001077 /* Get 'e' parameter: the encoding name */
1078 encoding = (const char *)va_arg(*p_va, const char *);
1079 if (encoding == NULL)
1080 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001081
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001082 /* Get output buffer parameter:
1083 's' (recode all objects via Unicode) or
1084 't' (only recode non-string objects)
1085 */
1086 if (*format == 's')
1087 recode_strings = 1;
1088 else if (*format == 't')
1089 recode_strings = 0;
1090 else
1091 return converterr(
1092 "(unknown parser marker combination)",
1093 arg, msgbuf, bufsize);
1094 buffer = (char **)va_arg(*p_va, char **);
1095 format++;
1096 if (buffer == NULL)
1097 return converterr("(buffer is NULL)",
1098 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001099
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001100 /* Encode object */
1101 if (!recode_strings &&
1102 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1103 s = arg;
1104 Py_INCREF(s);
1105 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1106 return converterr("(AsCharBuffer failed)",
1107 arg, msgbuf, bufsize);
1108 }
1109 else {
1110 PyObject *u;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001112 /* Convert object to Unicode */
1113 u = PyUnicode_FromObject(arg);
1114 if (u == NULL)
1115 return converterr(
1116 "string or unicode or text buffer",
1117 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001119 /* Encode object; use default error handling */
1120 s = PyUnicode_AsEncodedString(u,
1121 encoding,
1122 NULL);
1123 Py_DECREF(u);
1124 if (s == NULL)
1125 return converterr("(encoding failed)",
1126 arg, msgbuf, bufsize);
1127 if (!PyBytes_Check(s)) {
1128 Py_DECREF(s);
1129 return converterr(
1130 "(encoder failed to return bytes)",
1131 arg, msgbuf, bufsize);
1132 }
1133 size = PyBytes_GET_SIZE(s);
1134 ptr = PyBytes_AS_STRING(s);
1135 if (ptr == NULL)
1136 ptr = "";
1137 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001139 /* Write output; output is guaranteed to be 0-terminated */
1140 if (*format == '#') {
1141 /* Using buffer length parameter '#':
1142
1143 - if *buffer is NULL, a new buffer of the
1144 needed size is allocated and the data
1145 copied into it; *buffer is updated to point
1146 to the new buffer; the caller is
1147 responsible for PyMem_Free()ing it after
1148 usage
1149
1150 - if *buffer is not NULL, the data is
1151 copied to *buffer; *buffer_len has to be
1152 set to the size of the buffer on input;
1153 buffer overflow is signalled with an error;
1154 buffer has to provide enough room for the
1155 encoded string plus the trailing 0-byte
1156
1157 - in both cases, *buffer_len is updated to
1158 the size of the buffer /excluding/ the
1159 trailing 0-byte
1160
1161 */
1162 FETCH_SIZE;
1163
1164 format++;
1165 if (q == NULL && q2 == NULL) {
1166 Py_DECREF(s);
1167 return converterr(
1168 "(buffer_len is NULL)",
1169 arg, msgbuf, bufsize);
1170 }
1171 if (*buffer == NULL) {
1172 *buffer = PyMem_NEW(char, size + 1);
1173 if (*buffer == NULL) {
1174 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001175 PyErr_NoMemory();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001176 return converterr(
1177 "(memory error)",
1178 arg, msgbuf, bufsize);
1179 }
1180 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1181 Py_DECREF(s);
1182 return converterr(
1183 "(cleanup problem)",
1184 arg, msgbuf, bufsize);
1185 }
1186 } else {
1187 if (size + 1 > BUFFER_LEN) {
1188 Py_DECREF(s);
1189 return converterr(
1190 "(buffer overflow)",
1191 arg, msgbuf, bufsize);
1192 }
1193 }
1194 memcpy(*buffer, ptr, size+1);
1195 STORE_SIZE(size);
1196 } else {
1197 /* Using a 0-terminated buffer:
1198
1199 - the encoded string has to be 0-terminated
1200 for this variant to work; if it is not, an
1201 error raised
1202
1203 - a new buffer of the needed size is
1204 allocated and the data copied into it;
1205 *buffer is updated to point to the new
1206 buffer; the caller is responsible for
1207 PyMem_Free()ing it after usage
1208
1209 */
1210 if ((Py_ssize_t)strlen(ptr) != size) {
1211 Py_DECREF(s);
1212 return converterr(
1213 "encoded string without NULL bytes",
1214 arg, msgbuf, bufsize);
1215 }
1216 *buffer = PyMem_NEW(char, size + 1);
1217 if (*buffer == NULL) {
1218 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001219 PyErr_NoMemory();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001220 return converterr("(memory error)",
1221 arg, msgbuf, bufsize);
1222 }
1223 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1224 Py_DECREF(s);
1225 return converterr("(cleanup problem)",
1226 arg, msgbuf, bufsize);
1227 }
1228 memcpy(*buffer, ptr, size+1);
1229 }
1230 Py_DECREF(s);
1231 break;
1232 }
1233
1234 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1235 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1236 if (!PyUnicode_Check(arg))
1237 return converterr("str", arg, msgbuf, bufsize);
1238 *p = PyUnicode_AS_UNICODE(arg);
1239 if (*format == '#') { /* store pointer and size */
1240 FETCH_SIZE;
1241 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1242 format++;
1243 }
1244 break;
1245 }
1246
1247 case 'S': { /* PyBytes object */
1248 PyObject **p = va_arg(*p_va, PyObject **);
1249 if (PyBytes_Check(arg))
1250 *p = arg;
1251 else
1252 return converterr("bytes", arg, msgbuf, bufsize);
1253 break;
1254 }
1255
1256 case 'Y': { /* PyByteArray object */
1257 PyObject **p = va_arg(*p_va, PyObject **);
1258 if (PyByteArray_Check(arg))
1259 *p = arg;
1260 else
1261 return converterr("buffer", arg, msgbuf, bufsize);
1262 break;
1263 }
1264
1265 case 'U': { /* PyUnicode object */
1266 PyObject **p = va_arg(*p_va, PyObject **);
1267 if (PyUnicode_Check(arg))
1268 *p = arg;
1269 else
1270 return converterr("str", arg, msgbuf, bufsize);
1271 break;
1272 }
1273
1274 case 'O': { /* object */
1275 PyTypeObject *type;
1276 PyObject **p;
1277 if (*format == '!') {
1278 type = va_arg(*p_va, PyTypeObject*);
1279 p = va_arg(*p_va, PyObject **);
1280 format++;
1281 if (PyType_IsSubtype(arg->ob_type, type))
1282 *p = arg;
1283 else
1284 return converterr(type->tp_name, arg, msgbuf, bufsize);
1285
1286 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001287 else if (*format == '&') {
1288 typedef int (*converter)(PyObject *, void *);
1289 converter convert = va_arg(*p_va, converter);
1290 void *addr = va_arg(*p_va, void *);
1291 int res;
1292 format++;
1293 if (! (res = (*convert)(arg, addr)))
1294 return converterr("(unspecified)",
1295 arg, msgbuf, bufsize);
1296 if (res == Py_CLEANUP_SUPPORTED &&
1297 addcleanup_convert(addr, freelist, convert) == -1)
1298 return converterr("(cleanup problem)",
1299 arg, msgbuf, bufsize);
1300 }
1301 else {
1302 p = va_arg(*p_va, PyObject **);
1303 *p = arg;
1304 }
1305 break;
1306 }
1307
1308
1309 case 'w': { /* memory buffer, read-write access */
1310 void **p = va_arg(*p_va, void **);
1311 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1312 Py_ssize_t count;
1313 int temp=-1;
1314 Py_buffer view;
1315
1316 if (pb && pb->bf_releasebuffer && *format != '*')
1317 /* Buffer must be released, yet caller does not use
1318 the Py_buffer protocol. */
1319 return converterr("pinned buffer", arg, msgbuf, bufsize);
1320
1321
1322 if (pb && pb->bf_getbuffer && *format == '*') {
1323 /* Caller is interested in Py_buffer, and the object
1324 supports it directly. */
1325 format++;
1326 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1327 PyErr_Clear();
1328 return converterr("read-write buffer", arg, msgbuf, bufsize);
1329 }
1330 if (addcleanup(p, freelist, cleanup_buffer)) {
1331 return converterr(
1332 "(cleanup problem)",
1333 arg, msgbuf, bufsize);
1334 }
1335 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C'))
1336 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1337 break;
1338 }
1339
1340 /* Here we have processed w*, only w and w# remain. */
1341 if (pb == NULL ||
1342 pb->bf_getbuffer == NULL ||
1343 ((temp = PyObject_GetBuffer(arg, &view,
1344 PyBUF_SIMPLE)) != 0) ||
1345 view.readonly == 1) {
1346 if (temp==0) {
1347 PyBuffer_Release(&view);
1348 }
1349 return converterr("single-segment read-write buffer",
1350 arg, msgbuf, bufsize);
1351 }
1352
1353 if ((count = view.len) < 0)
1354 return converterr("(unspecified)", arg, msgbuf, bufsize);
1355 *p = view.buf;
1356 if (*format == '#') {
1357 FETCH_SIZE;
1358 STORE_SIZE(count);
1359 format++;
1360 }
1361 break;
1362 }
1363
1364 /*TEO: This can be eliminated --- here only for backward
1365 compatibility */
1366 case 't': { /* 8-bit character buffer, read-only access */
1367 char **p = va_arg(*p_va, char **);
1368 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1369 Py_ssize_t count;
1370 Py_buffer view;
1371
1372 if (*format++ != '#')
1373 return converterr(
1374 "invalid use of 't' format character",
1375 arg, msgbuf, bufsize);
1376 if (pb == NULL || pb->bf_getbuffer == NULL)
1377 return converterr(
1378 "bytes or read-only character buffer",
1379 arg, msgbuf, bufsize);
1380
1381 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0)
1382 return converterr("string or single-segment read-only buffer",
1383 arg, msgbuf, bufsize);
1384
1385 count = view.len;
1386 *p = view.buf;
1387 if (pb->bf_releasebuffer)
1388 return converterr(
1389 "string or pinned buffer",
1390 arg, msgbuf, bufsize);
1391
1392 PyBuffer_Release(&view);
1393
1394 if (count < 0)
1395 return converterr("(unspecified)", arg, msgbuf, bufsize);
1396 {
1397 FETCH_SIZE;
1398 STORE_SIZE(count);
1399 }
1400 break;
1401 }
1402
1403 default:
1404 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
1405
1406 }
1407
1408 *p_format = format;
1409 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001410}
Guido van Rossumaa354651996-08-19 19:32:04 +00001411
Martin v. Löwis18e16552006-02-15 17:27:45 +00001412static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001413convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001414{
Victor Stinner5cb62392010-06-06 20:27:51 +00001415 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001416 Py_ssize_t count;
1417 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 *errmsg = NULL;
1420 *p = NULL;
1421 if (pb == NULL ||
1422 pb->bf_getbuffer == NULL ||
1423 pb->bf_releasebuffer != NULL) {
1424 *errmsg = "bytes or read-only buffer";
1425 return -1;
1426 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0) {
1429 *errmsg = "bytes or single-segment read-only buffer";
1430 return -1;
1431 }
1432 count = view.len;
1433 *p = view.buf;
1434 PyBuffer_Release(&view);
1435 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001436}
Guido van Rossumaa354651996-08-19 19:32:04 +00001437
Martin v. Löwis423be952008-08-13 15:53:07 +00001438/* XXX for 3.x, getbuffer and convertbuffer can probably
1439 be merged again. */
1440static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001441getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001442{
Victor Stinner5cb62392010-06-06 20:27:51 +00001443 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 if (pb == NULL) {
1445 *errmsg = "bytes or buffer";
1446 return -1;
1447 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001448 if (pb->bf_getbuffer == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001449 *errmsg = "convertible to a buffer";
Victor Stinner5cb62392010-06-06 20:27:51 +00001450 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001452 if (PyObject_GetBuffer(arg, view, 0) < 0) {
1453 *errmsg = "convertible to a buffer";
1454 return -1;
1455 }
1456 if (!PyBuffer_IsContiguous(view, 'C')) {
1457 *errmsg = "contiguous buffer";
1458 return -1;
1459 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001461}
1462
Guido van Rossumaa354651996-08-19 19:32:04 +00001463/* Support for keyword arguments donated by
1464 Geoff Philbrick <philbric@delphi.hks.com> */
1465
Tim Petersf8cd3e82001-10-27 04:26:57 +00001466/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001467int
1468PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 PyObject *keywords,
1470 const char *format,
1471 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001472{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001473 int retval;
1474 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001475
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001476 if ((args == NULL || !PyTuple_Check(args)) ||
1477 (keywords != NULL && !PyDict_Check(keywords)) ||
1478 format == NULL ||
1479 kwlist == NULL)
1480 {
1481 PyErr_BadInternalCall();
1482 return 0;
1483 }
Tim Peters45772cd2001-10-27 03:58:40 +00001484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001485 va_start(va, kwlist);
1486 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1487 va_end(va);
1488 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001489}
1490
1491int
1492_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 PyObject *keywords,
1494 const char *format,
1495 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001496{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 int retval;
1498 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 if ((args == NULL || !PyTuple_Check(args)) ||
1501 (keywords != NULL && !PyDict_Check(keywords)) ||
1502 format == NULL ||
1503 kwlist == NULL)
1504 {
1505 PyErr_BadInternalCall();
1506 return 0;
1507 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001508
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001509 va_start(va, kwlist);
1510 retval = vgetargskeywords(args, keywords, format,
1511 kwlist, &va, FLAG_SIZE_T);
1512 va_end(va);
1513 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001514}
1515
1516
Brett Cannon711e7d92004-07-10 22:20:32 +00001517int
1518PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001519 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001520 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001521 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001522{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001523 int retval;
1524 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001534
1535#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001536 memcpy(lva, va, sizeof(va_list));
Brett Cannon711e7d92004-07-10 22:20:32 +00001537#else
1538#ifdef __va_copy
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001539 __va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001540#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001541 lva = va;
Brett Cannon711e7d92004-07-10 22:20:32 +00001542#endif
1543#endif
1544
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1546 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001547}
1548
1549int
1550_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001551 PyObject *keywords,
1552 const char *format,
1553 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001554{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001555 int retval;
1556 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 if ((args == NULL || !PyTuple_Check(args)) ||
1559 (keywords != NULL && !PyDict_Check(keywords)) ||
1560 format == NULL ||
1561 kwlist == NULL)
1562 {
1563 PyErr_BadInternalCall();
1564 return 0;
1565 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001566
1567#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001568 memcpy(lva, va, sizeof(va_list));
Martin v. Löwis18e16552006-02-15 17:27:45 +00001569#else
1570#ifdef __va_copy
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 __va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001572#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001573 lva = va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001574#endif
1575#endif
1576
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001577 retval = vgetargskeywords(args, keywords, format,
1578 kwlist, &lva, FLAG_SIZE_T);
1579 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001580}
1581
Benjamin Petersonfb886362010-04-24 18:21:17 +00001582int
1583PyArg_ValidateKeywordArguments(PyObject *kwargs)
1584{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 if (!PyDict_CheckExact(kwargs)) {
1586 PyErr_BadInternalCall();
1587 return 0;
1588 }
1589 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1590 PyErr_SetString(PyExc_TypeError,
1591 "keyword arguments must be strings");
1592 return 0;
1593 }
1594 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001595}
1596
Christian Heimes380f7f22008-02-28 11:19:05 +00001597#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001598
Guido van Rossumaa354651996-08-19 19:32:04 +00001599static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001600vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001601 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001602{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 char msgbuf[512];
1604 int levels[32];
1605 const char *fname, *msg, *custom_msg, *keyword;
1606 int min = INT_MAX;
1607 int i, len, nargs, nkeywords;
1608 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001609
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001610 assert(args != NULL && PyTuple_Check(args));
1611 assert(keywords == NULL || PyDict_Check(keywords));
1612 assert(format != NULL);
1613 assert(kwlist != NULL);
1614 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001615
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 /* grab the function name or custom error msg first (mutually exclusive) */
1617 fname = strchr(format, ':');
1618 if (fname) {
1619 fname++;
1620 custom_msg = NULL;
1621 }
1622 else {
1623 custom_msg = strchr(format,';');
1624 if (custom_msg)
1625 custom_msg++;
1626 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 /* scan kwlist and get greatest possible nbr of args */
1629 for (len=0; kwlist[len]; len++)
1630 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001631
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 nargs = PyTuple_GET_SIZE(args);
1633 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1634 if (nargs + nkeywords > len) {
1635 PyErr_Format(PyExc_TypeError, "%s%s takes at most %d "
1636 "argument%s (%d given)",
1637 (fname == NULL) ? "function" : fname,
1638 (fname == NULL) ? "" : "()",
1639 len,
1640 (len == 1) ? "" : "s",
1641 nargs + nkeywords);
1642 return 0;
1643 }
Tim Petersc2f01122001-10-27 07:25:06 +00001644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1646 for (i = 0; i < len; i++) {
1647 keyword = kwlist[i];
1648 if (*format == '|') {
1649 min = i;
1650 format++;
1651 }
1652 if (IS_END_OF_FORMAT(*format)) {
1653 PyErr_Format(PyExc_RuntimeError,
1654 "More keyword list entries (%d) than "
1655 "format specifiers (%d)", len, i);
1656 return cleanreturn(0, freelist);
1657 }
1658 current_arg = NULL;
1659 if (nkeywords) {
1660 current_arg = PyDict_GetItemString(keywords, keyword);
1661 }
1662 if (current_arg) {
1663 --nkeywords;
1664 if (i < nargs) {
1665 /* arg present in tuple and in dict */
1666 PyErr_Format(PyExc_TypeError,
1667 "Argument given by name ('%s') "
1668 "and position (%d)",
1669 keyword, i+1);
1670 return cleanreturn(0, freelist);
1671 }
1672 }
1673 else if (nkeywords && PyErr_Occurred())
1674 return cleanreturn(0, freelist);
1675 else if (i < nargs)
1676 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimes380f7f22008-02-28 11:19:05 +00001677
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001678 if (current_arg) {
1679 msg = convertitem(current_arg, &format, p_va, flags,
1680 levels, msgbuf, sizeof(msgbuf), &freelist);
1681 if (msg) {
1682 seterror(i+1, msg, levels, fname, custom_msg);
1683 return cleanreturn(0, freelist);
1684 }
1685 continue;
1686 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001687
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001688 if (i < min) {
1689 PyErr_Format(PyExc_TypeError, "Required argument "
1690 "'%s' (pos %d) not found",
1691 keyword, i+1);
1692 return cleanreturn(0, freelist);
1693 }
1694 /* current code reports success when all required args
1695 * fulfilled and no keyword args left, with no further
1696 * validation. XXX Maybe skip this in debug build ?
1697 */
1698 if (!nkeywords)
1699 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001700
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001701 /* We are into optional args, skip thru to any remaining
1702 * keyword args */
1703 msg = skipitem(&format, p_va, flags);
1704 if (msg) {
1705 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1706 format);
1707 return cleanreturn(0, freelist);
1708 }
1709 }
Tim Petersb054be42001-10-27 05:07:41 +00001710
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
1712 PyErr_Format(PyExc_RuntimeError,
1713 "more argument specifiers than keyword list entries "
1714 "(remaining format:'%s')", format);
1715 return cleanreturn(0, freelist);
1716 }
Tim Petersc2f01122001-10-27 07:25:06 +00001717
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001718 /* make sure there are no extraneous keyword arguments */
1719 if (nkeywords > 0) {
1720 PyObject *key, *value;
1721 Py_ssize_t pos = 0;
1722 while (PyDict_Next(keywords, &pos, &key, &value)) {
1723 int match = 0;
1724 char *ks;
1725 if (!PyUnicode_Check(key)) {
1726 PyErr_SetString(PyExc_TypeError,
1727 "keywords must be strings");
1728 return cleanreturn(0, freelist);
1729 }
Victor Stinner93b55132010-05-19 00:54:06 +00001730 /* check that _PyUnicode_AsString() result is not NULL */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001731 ks = _PyUnicode_AsString(key);
Victor Stinner93b55132010-05-19 00:54:06 +00001732 if (ks != NULL) {
1733 for (i = 0; i < len; i++) {
1734 if (!strcmp(ks, kwlist[i])) {
1735 match = 1;
1736 break;
1737 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001738 }
1739 }
1740 if (!match) {
1741 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001742 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001743 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001744 key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001745 return cleanreturn(0, freelist);
1746 }
1747 }
1748 }
1749
1750 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001751}
1752
1753
1754static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001755skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001756{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001757 const char *format = *p_format;
1758 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001759
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001760 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001761
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001762 /* simple codes
1763 * The individual types (second arg of va_arg) are irrelevant */
Georg Brandl6dd14612005-09-14 19:29:53 +00001764
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001765 case 'b': /* byte -- very short int */
1766 case 'B': /* byte as bitfield */
1767 case 'h': /* short int */
1768 case 'H': /* short int as bitfield */
1769 case 'i': /* int */
1770 case 'I': /* int sized bitfield */
1771 case 'l': /* long int */
1772 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001773#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001774 case 'L': /* PY_LONG_LONG */
1775 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001776#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001777 case 'f': /* float */
1778 case 'd': /* double */
1779 case 'D': /* complex double */
1780 case 'c': /* char */
1781 case 'C': /* unicode char */
1782 {
1783 (void) va_arg(*p_va, void *);
1784 break;
1785 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001786
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001787 case 'n': /* Py_ssize_t */
1788 {
1789 (void) va_arg(*p_va, Py_ssize_t *);
1790 break;
1791 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001792
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001793 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001794
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001795 case 'e': /* string with encoding */
1796 {
1797 (void) va_arg(*p_va, const char *);
1798 if (!(*format == 's' || *format == 't'))
1799 /* after 'e', only 's' and 't' is allowed */
1800 goto err;
1801 format++;
1802 /* explicit fallthrough to string cases */
1803 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001804
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001805 case 's': /* string */
1806 case 'z': /* string or None */
1807 case 'y': /* bytes */
1808 case 'u': /* unicode string */
1809 case 't': /* buffer, read-only */
1810 case 'w': /* buffer, read-write */
1811 {
1812 (void) va_arg(*p_va, char **);
1813 if (*format == '#') {
1814 if (flags & FLAG_SIZE_T)
1815 (void) va_arg(*p_va, Py_ssize_t *);
1816 else
1817 (void) va_arg(*p_va, int *);
1818 format++;
1819 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1820 format++;
1821 }
1822 break;
1823 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001824
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001825 /* object codes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001826
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001827 case 'S': /* string object */
1828 case 'Y': /* string object */
1829 case 'U': /* unicode string object */
1830 {
1831 (void) va_arg(*p_va, PyObject **);
1832 break;
1833 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001834
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001835 case 'O': /* object */
1836 {
1837 if (*format == '!') {
1838 format++;
1839 (void) va_arg(*p_va, PyTypeObject*);
1840 (void) va_arg(*p_va, PyObject **);
1841 }
1842 else if (*format == '&') {
1843 typedef int (*converter)(PyObject *, void *);
1844 (void) va_arg(*p_va, converter);
1845 (void) va_arg(*p_va, void *);
1846 format++;
1847 }
1848 else {
1849 (void) va_arg(*p_va, PyObject **);
1850 }
1851 break;
1852 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001853
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001854 case '(': /* bypass tuple, not handled at all previously */
1855 {
1856 char *msg;
1857 for (;;) {
1858 if (*format==')')
1859 break;
1860 if (IS_END_OF_FORMAT(*format))
1861 return "Unmatched left paren in format "
1862 "string";
1863 msg = skipitem(&format, p_va, flags);
1864 if (msg)
1865 return msg;
1866 }
1867 format++;
1868 break;
1869 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001870
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001871 case ')':
1872 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00001873
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001874 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001875err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001876 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001878 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001880 *p_format = format;
1881 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001882}
Fred Drakee4616e62001-10-23 21:09:29 +00001883
1884
1885int
Martin v. Löwis76246742006-03-01 04:06:10 +00001886PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001887{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001888 Py_ssize_t i, l;
1889 PyObject **o;
1890 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001891
1892#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001893 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001894#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001895 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001896#endif
1897
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001898 assert(min >= 0);
1899 assert(min <= max);
1900 if (!PyTuple_Check(args)) {
1901 PyErr_SetString(PyExc_SystemError,
1902 "PyArg_UnpackTuple() argument list is not a tuple");
1903 return 0;
1904 }
1905 l = PyTuple_GET_SIZE(args);
1906 if (l < min) {
1907 if (name != NULL)
1908 PyErr_Format(
1909 PyExc_TypeError,
1910 "%s expected %s%zd arguments, got %zd",
1911 name, (min == max ? "" : "at least "), min, l);
1912 else
1913 PyErr_Format(
1914 PyExc_TypeError,
1915 "unpacked tuple should have %s%zd elements,"
1916 " but has %zd",
1917 (min == max ? "" : "at least "), min, l);
1918 va_end(vargs);
1919 return 0;
1920 }
1921 if (l > max) {
1922 if (name != NULL)
1923 PyErr_Format(
1924 PyExc_TypeError,
1925 "%s expected %s%zd arguments, got %zd",
1926 name, (min == max ? "" : "at most "), max, l);
1927 else
1928 PyErr_Format(
1929 PyExc_TypeError,
1930 "unpacked tuple should have %s%zd elements,"
1931 " but has %zd",
1932 (min == max ? "" : "at most "), max, l);
1933 va_end(vargs);
1934 return 0;
1935 }
1936 for (i = 0; i < l; i++) {
1937 o = va_arg(vargs, PyObject **);
1938 *o = PyTuple_GET_ITEM(args, i);
1939 }
1940 va_end(vargs);
1941 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001942}
Georg Brandl02c42872005-08-26 06:42:30 +00001943
1944
1945/* For type constructors that don't take keyword args
1946 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001947 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001948 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001949 */
1950int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001951_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001952{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001953 if (kw == NULL)
1954 return 1;
1955 if (!PyDict_CheckExact(kw)) {
1956 PyErr_BadInternalCall();
1957 return 0;
1958 }
1959 if (PyDict_Size(kw) == 0)
1960 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001961
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001962 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1963 funcname);
1964 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001965}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001966#ifdef __cplusplus
1967};
1968#endif