blob: e8efb3c27939e7d60dffee0286d8b076d2b0c9b3 [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);
1032 if (*format == '#') {
1033 FETCH_SIZE;
1034 assert(0); /* XXX redundant with if-case */
1035 if (arg == Py_None) {
1036 STORE_SIZE(0);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001037 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001038 else {
1039 STORE_SIZE(PyBytes_Size(arg));
1040 }
1041 format++;
1042 }
1043 else if (*p != NULL && uarg != NULL &&
1044 (Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
1045 return converterr(
1046 "string without null bytes or None",
1047 arg, msgbuf, bufsize);
1048 }
1049 break;
1050 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001051
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001052 case 'Z': {/* unicode, may be NULL (None) */
1053 if (*format == '#') { /* any buffer-like object */
1054 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1055 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001056
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001057 if (arg == Py_None) {
1058 *p = 0;
1059 STORE_SIZE(0);
1060 }
1061 else if (PyUnicode_Check(arg)) {
1062 *p = PyUnicode_AS_UNICODE(arg);
1063 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1064 }
1065 format++;
1066 } else {
1067 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001068
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001069 if (arg == Py_None)
1070 *p = 0;
1071 else if (PyUnicode_Check(arg))
1072 *p = PyUnicode_AS_UNICODE(arg);
1073 else
1074 return converterr("string or None",
1075 arg, msgbuf, bufsize);
1076 }
1077 break;
1078 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001079
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001080 case 'e': {/* encoded string */
1081 char **buffer;
1082 const char *encoding;
1083 PyObject *s;
1084 int recode_strings;
1085 Py_ssize_t size;
1086 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001087
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001088 /* Get 'e' parameter: the encoding name */
1089 encoding = (const char *)va_arg(*p_va, const char *);
1090 if (encoding == NULL)
1091 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001092
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 /* Get output buffer parameter:
1094 's' (recode all objects via Unicode) or
1095 't' (only recode non-string objects)
1096 */
1097 if (*format == 's')
1098 recode_strings = 1;
1099 else if (*format == 't')
1100 recode_strings = 0;
1101 else
1102 return converterr(
1103 "(unknown parser marker combination)",
1104 arg, msgbuf, bufsize);
1105 buffer = (char **)va_arg(*p_va, char **);
1106 format++;
1107 if (buffer == NULL)
1108 return converterr("(buffer is NULL)",
1109 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001110
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001111 /* Encode object */
1112 if (!recode_strings &&
1113 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1114 s = arg;
1115 Py_INCREF(s);
1116 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1117 return converterr("(AsCharBuffer failed)",
1118 arg, msgbuf, bufsize);
1119 }
1120 else {
1121 PyObject *u;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001122
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001123 /* Convert object to Unicode */
1124 u = PyUnicode_FromObject(arg);
1125 if (u == NULL)
1126 return converterr(
1127 "string or unicode or text buffer",
1128 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001129
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001130 /* Encode object; use default error handling */
1131 s = PyUnicode_AsEncodedString(u,
1132 encoding,
1133 NULL);
1134 Py_DECREF(u);
1135 if (s == NULL)
1136 return converterr("(encoding failed)",
1137 arg, msgbuf, bufsize);
1138 if (!PyBytes_Check(s)) {
1139 Py_DECREF(s);
1140 return converterr(
1141 "(encoder failed to return bytes)",
1142 arg, msgbuf, bufsize);
1143 }
1144 size = PyBytes_GET_SIZE(s);
1145 ptr = PyBytes_AS_STRING(s);
1146 if (ptr == NULL)
1147 ptr = "";
1148 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001149
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001150 /* Write output; output is guaranteed to be 0-terminated */
1151 if (*format == '#') {
1152 /* Using buffer length parameter '#':
1153
1154 - if *buffer is NULL, a new buffer of the
1155 needed size is allocated and the data
1156 copied into it; *buffer is updated to point
1157 to the new buffer; the caller is
1158 responsible for PyMem_Free()ing it after
1159 usage
1160
1161 - if *buffer is not NULL, the data is
1162 copied to *buffer; *buffer_len has to be
1163 set to the size of the buffer on input;
1164 buffer overflow is signalled with an error;
1165 buffer has to provide enough room for the
1166 encoded string plus the trailing 0-byte
1167
1168 - in both cases, *buffer_len is updated to
1169 the size of the buffer /excluding/ the
1170 trailing 0-byte
1171
1172 */
1173 FETCH_SIZE;
1174
1175 format++;
1176 if (q == NULL && q2 == NULL) {
1177 Py_DECREF(s);
1178 return converterr(
1179 "(buffer_len is NULL)",
1180 arg, msgbuf, bufsize);
1181 }
1182 if (*buffer == NULL) {
1183 *buffer = PyMem_NEW(char, size + 1);
1184 if (*buffer == NULL) {
1185 Py_DECREF(s);
1186 return converterr(
1187 "(memory error)",
1188 arg, msgbuf, bufsize);
1189 }
1190 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1191 Py_DECREF(s);
1192 return converterr(
1193 "(cleanup problem)",
1194 arg, msgbuf, bufsize);
1195 }
1196 } else {
1197 if (size + 1 > BUFFER_LEN) {
1198 Py_DECREF(s);
1199 return converterr(
1200 "(buffer overflow)",
1201 arg, msgbuf, bufsize);
1202 }
1203 }
1204 memcpy(*buffer, ptr, size+1);
1205 STORE_SIZE(size);
1206 } else {
1207 /* Using a 0-terminated buffer:
1208
1209 - the encoded string has to be 0-terminated
1210 for this variant to work; if it is not, an
1211 error raised
1212
1213 - a new buffer of the needed size is
1214 allocated and the data copied into it;
1215 *buffer is updated to point to the new
1216 buffer; the caller is responsible for
1217 PyMem_Free()ing it after usage
1218
1219 */
1220 if ((Py_ssize_t)strlen(ptr) != size) {
1221 Py_DECREF(s);
1222 return converterr(
1223 "encoded string without NULL bytes",
1224 arg, msgbuf, bufsize);
1225 }
1226 *buffer = PyMem_NEW(char, size + 1);
1227 if (*buffer == NULL) {
1228 Py_DECREF(s);
1229 return converterr("(memory error)",
1230 arg, msgbuf, bufsize);
1231 }
1232 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1233 Py_DECREF(s);
1234 return converterr("(cleanup problem)",
1235 arg, msgbuf, bufsize);
1236 }
1237 memcpy(*buffer, ptr, size+1);
1238 }
1239 Py_DECREF(s);
1240 break;
1241 }
1242
1243 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1244 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1245 if (!PyUnicode_Check(arg))
1246 return converterr("str", arg, msgbuf, bufsize);
1247 *p = PyUnicode_AS_UNICODE(arg);
1248 if (*format == '#') { /* store pointer and size */
1249 FETCH_SIZE;
1250 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1251 format++;
1252 }
1253 break;
1254 }
1255
1256 case 'S': { /* PyBytes object */
1257 PyObject **p = va_arg(*p_va, PyObject **);
1258 if (PyBytes_Check(arg))
1259 *p = arg;
1260 else
1261 return converterr("bytes", arg, msgbuf, bufsize);
1262 break;
1263 }
1264
1265 case 'Y': { /* PyByteArray object */
1266 PyObject **p = va_arg(*p_va, PyObject **);
1267 if (PyByteArray_Check(arg))
1268 *p = arg;
1269 else
1270 return converterr("buffer", arg, msgbuf, bufsize);
1271 break;
1272 }
1273
1274 case 'U': { /* PyUnicode object */
1275 PyObject **p = va_arg(*p_va, PyObject **);
1276 if (PyUnicode_Check(arg))
1277 *p = arg;
1278 else
1279 return converterr("str", arg, msgbuf, bufsize);
1280 break;
1281 }
1282
1283 case 'O': { /* object */
1284 PyTypeObject *type;
1285 PyObject **p;
1286 if (*format == '!') {
1287 type = va_arg(*p_va, PyTypeObject*);
1288 p = va_arg(*p_va, PyObject **);
1289 format++;
1290 if (PyType_IsSubtype(arg->ob_type, type))
1291 *p = arg;
1292 else
1293 return converterr(type->tp_name, arg, msgbuf, bufsize);
1294
1295 }
1296 else if (*format == '?') {
1297 inquiry pred = va_arg(*p_va, inquiry);
1298 p = va_arg(*p_va, PyObject **);
1299 format++;
1300 if ((*pred)(arg))
1301 *p = arg;
1302 else
1303 return converterr("(unspecified)",
1304 arg, msgbuf, bufsize);
1305
1306 }
1307 else if (*format == '&') {
1308 typedef int (*converter)(PyObject *, void *);
1309 converter convert = va_arg(*p_va, converter);
1310 void *addr = va_arg(*p_va, void *);
1311 int res;
1312 format++;
1313 if (! (res = (*convert)(arg, addr)))
1314 return converterr("(unspecified)",
1315 arg, msgbuf, bufsize);
1316 if (res == Py_CLEANUP_SUPPORTED &&
1317 addcleanup_convert(addr, freelist, convert) == -1)
1318 return converterr("(cleanup problem)",
1319 arg, msgbuf, bufsize);
1320 }
1321 else {
1322 p = va_arg(*p_va, PyObject **);
1323 *p = arg;
1324 }
1325 break;
1326 }
1327
1328
1329 case 'w': { /* memory buffer, read-write access */
1330 void **p = va_arg(*p_va, void **);
1331 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1332 Py_ssize_t count;
1333 int temp=-1;
1334 Py_buffer view;
1335
1336 if (pb && pb->bf_releasebuffer && *format != '*')
1337 /* Buffer must be released, yet caller does not use
1338 the Py_buffer protocol. */
1339 return converterr("pinned buffer", arg, msgbuf, bufsize);
1340
1341
1342 if (pb && pb->bf_getbuffer && *format == '*') {
1343 /* Caller is interested in Py_buffer, and the object
1344 supports it directly. */
1345 format++;
1346 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1347 PyErr_Clear();
1348 return converterr("read-write buffer", arg, msgbuf, bufsize);
1349 }
1350 if (addcleanup(p, freelist, cleanup_buffer)) {
1351 return converterr(
1352 "(cleanup problem)",
1353 arg, msgbuf, bufsize);
1354 }
1355 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C'))
1356 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1357 break;
1358 }
1359
1360 /* Here we have processed w*, only w and w# remain. */
1361 if (pb == NULL ||
1362 pb->bf_getbuffer == NULL ||
1363 ((temp = PyObject_GetBuffer(arg, &view,
1364 PyBUF_SIMPLE)) != 0) ||
1365 view.readonly == 1) {
1366 if (temp==0) {
1367 PyBuffer_Release(&view);
1368 }
1369 return converterr("single-segment read-write buffer",
1370 arg, msgbuf, bufsize);
1371 }
1372
1373 if ((count = view.len) < 0)
1374 return converterr("(unspecified)", arg, msgbuf, bufsize);
1375 *p = view.buf;
1376 if (*format == '#') {
1377 FETCH_SIZE;
1378 STORE_SIZE(count);
1379 format++;
1380 }
1381 break;
1382 }
1383
1384 /*TEO: This can be eliminated --- here only for backward
1385 compatibility */
1386 case 't': { /* 8-bit character buffer, read-only access */
1387 char **p = va_arg(*p_va, char **);
1388 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1389 Py_ssize_t count;
1390 Py_buffer view;
1391
1392 if (*format++ != '#')
1393 return converterr(
1394 "invalid use of 't' format character",
1395 arg, msgbuf, bufsize);
1396 if (pb == NULL || pb->bf_getbuffer == NULL)
1397 return converterr(
1398 "bytes or read-only character buffer",
1399 arg, msgbuf, bufsize);
1400
1401 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0)
1402 return converterr("string or single-segment read-only buffer",
1403 arg, msgbuf, bufsize);
1404
1405 count = view.len;
1406 *p = view.buf;
1407 if (pb->bf_releasebuffer)
1408 return converterr(
1409 "string or pinned buffer",
1410 arg, msgbuf, bufsize);
1411
1412 PyBuffer_Release(&view);
1413
1414 if (count < 0)
1415 return converterr("(unspecified)", arg, msgbuf, bufsize);
1416 {
1417 FETCH_SIZE;
1418 STORE_SIZE(count);
1419 }
1420 break;
1421 }
1422
1423 default:
1424 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
1425
1426 }
1427
1428 *p_format = format;
1429 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001430}
Guido van Rossumaa354651996-08-19 19:32:04 +00001431
Martin v. Löwis18e16552006-02-15 17:27:45 +00001432static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001433convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001434{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001435 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1436 Py_ssize_t count;
1437 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001439 *errmsg = NULL;
1440 *p = NULL;
1441 if (pb == NULL ||
1442 pb->bf_getbuffer == NULL ||
1443 pb->bf_releasebuffer != NULL) {
1444 *errmsg = "bytes or read-only buffer";
1445 return -1;
1446 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0) {
1449 *errmsg = "bytes or single-segment read-only buffer";
1450 return -1;
1451 }
1452 count = view.len;
1453 *p = view.buf;
1454 PyBuffer_Release(&view);
1455 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001456}
Guido van Rossumaa354651996-08-19 19:32:04 +00001457
Martin v. Löwis423be952008-08-13 15:53:07 +00001458/* XXX for 3.x, getbuffer and convertbuffer can probably
1459 be merged again. */
1460static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001461getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001462{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 void *buf;
1464 Py_ssize_t count;
1465 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1466 if (pb == NULL) {
1467 *errmsg = "bytes or buffer";
1468 return -1;
1469 }
1470 if (pb->bf_getbuffer) {
1471 if (PyObject_GetBuffer(arg, view, 0) < 0) {
1472 *errmsg = "convertible to a buffer";
1473 return -1;
1474 }
1475 if (!PyBuffer_IsContiguous(view, 'C')) {
1476 *errmsg = "contiguous buffer";
1477 return -1;
1478 }
1479 return 0;
1480 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 count = convertbuffer(arg, &buf, errmsg);
1483 if (count < 0) {
1484 *errmsg = "convertible to a buffer";
1485 return count;
1486 }
1487 PyBuffer_FillInfo(view, NULL, buf, count, 1, 0);
1488 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001489}
1490
Guido van Rossumaa354651996-08-19 19:32:04 +00001491/* Support for keyword arguments donated by
1492 Geoff Philbrick <philbric@delphi.hks.com> */
1493
Tim Petersf8cd3e82001-10-27 04:26:57 +00001494/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001495int
1496PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 PyObject *keywords,
1498 const char *format,
1499 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001500{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 int retval;
1502 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001503
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 if ((args == NULL || !PyTuple_Check(args)) ||
1505 (keywords != NULL && !PyDict_Check(keywords)) ||
1506 format == NULL ||
1507 kwlist == NULL)
1508 {
1509 PyErr_BadInternalCall();
1510 return 0;
1511 }
Tim Peters45772cd2001-10-27 03:58:40 +00001512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001513 va_start(va, kwlist);
1514 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1515 va_end(va);
1516 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001517}
1518
1519int
1520_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001521 PyObject *keywords,
1522 const char *format,
1523 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001524{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 int retval;
1526 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001528 if ((args == NULL || !PyTuple_Check(args)) ||
1529 (keywords != NULL && !PyDict_Check(keywords)) ||
1530 format == NULL ||
1531 kwlist == NULL)
1532 {
1533 PyErr_BadInternalCall();
1534 return 0;
1535 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 va_start(va, kwlist);
1538 retval = vgetargskeywords(args, keywords, format,
1539 kwlist, &va, FLAG_SIZE_T);
1540 va_end(va);
1541 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001542}
1543
1544
Brett Cannon711e7d92004-07-10 22:20:32 +00001545int
1546PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001547 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001548 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001549 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001550{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001551 int retval;
1552 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001553
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001554 if ((args == NULL || !PyTuple_Check(args)) ||
1555 (keywords != NULL && !PyDict_Check(keywords)) ||
1556 format == NULL ||
1557 kwlist == NULL)
1558 {
1559 PyErr_BadInternalCall();
1560 return 0;
1561 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001562
1563#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001564 memcpy(lva, va, sizeof(va_list));
Brett Cannon711e7d92004-07-10 22:20:32 +00001565#else
1566#ifdef __va_copy
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 __va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001568#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001569 lva = va;
Brett Cannon711e7d92004-07-10 22:20:32 +00001570#endif
1571#endif
1572
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001573 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1574 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001575}
1576
1577int
1578_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001579 PyObject *keywords,
1580 const char *format,
1581 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001582{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 int retval;
1584 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 if ((args == NULL || !PyTuple_Check(args)) ||
1587 (keywords != NULL && !PyDict_Check(keywords)) ||
1588 format == NULL ||
1589 kwlist == NULL)
1590 {
1591 PyErr_BadInternalCall();
1592 return 0;
1593 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001594
1595#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 memcpy(lva, va, sizeof(va_list));
Martin v. Löwis18e16552006-02-15 17:27:45 +00001597#else
1598#ifdef __va_copy
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 __va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001600#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001601 lva = va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001602#endif
1603#endif
1604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001605 retval = vgetargskeywords(args, keywords, format,
1606 kwlist, &lva, FLAG_SIZE_T);
1607 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001608}
1609
Benjamin Petersonfb886362010-04-24 18:21:17 +00001610int
1611PyArg_ValidateKeywordArguments(PyObject *kwargs)
1612{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 if (!PyDict_CheckExact(kwargs)) {
1614 PyErr_BadInternalCall();
1615 return 0;
1616 }
1617 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1618 PyErr_SetString(PyExc_TypeError,
1619 "keyword arguments must be strings");
1620 return 0;
1621 }
1622 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001623}
1624
Christian Heimes380f7f22008-02-28 11:19:05 +00001625#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001626
Guido van Rossumaa354651996-08-19 19:32:04 +00001627static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001628vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001630{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001631 char msgbuf[512];
1632 int levels[32];
1633 const char *fname, *msg, *custom_msg, *keyword;
1634 int min = INT_MAX;
1635 int i, len, nargs, nkeywords;
1636 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001638 assert(args != NULL && PyTuple_Check(args));
1639 assert(keywords == NULL || PyDict_Check(keywords));
1640 assert(format != NULL);
1641 assert(kwlist != NULL);
1642 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001643
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001644 /* grab the function name or custom error msg first (mutually exclusive) */
1645 fname = strchr(format, ':');
1646 if (fname) {
1647 fname++;
1648 custom_msg = NULL;
1649 }
1650 else {
1651 custom_msg = strchr(format,';');
1652 if (custom_msg)
1653 custom_msg++;
1654 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001655
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001656 /* scan kwlist and get greatest possible nbr of args */
1657 for (len=0; kwlist[len]; len++)
1658 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001659
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001660 nargs = PyTuple_GET_SIZE(args);
1661 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1662 if (nargs + nkeywords > len) {
1663 PyErr_Format(PyExc_TypeError, "%s%s takes at most %d "
1664 "argument%s (%d given)",
1665 (fname == NULL) ? "function" : fname,
1666 (fname == NULL) ? "" : "()",
1667 len,
1668 (len == 1) ? "" : "s",
1669 nargs + nkeywords);
1670 return 0;
1671 }
Tim Petersc2f01122001-10-27 07:25:06 +00001672
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1674 for (i = 0; i < len; i++) {
1675 keyword = kwlist[i];
1676 if (*format == '|') {
1677 min = i;
1678 format++;
1679 }
1680 if (IS_END_OF_FORMAT(*format)) {
1681 PyErr_Format(PyExc_RuntimeError,
1682 "More keyword list entries (%d) than "
1683 "format specifiers (%d)", len, i);
1684 return cleanreturn(0, freelist);
1685 }
1686 current_arg = NULL;
1687 if (nkeywords) {
1688 current_arg = PyDict_GetItemString(keywords, keyword);
1689 }
1690 if (current_arg) {
1691 --nkeywords;
1692 if (i < nargs) {
1693 /* arg present in tuple and in dict */
1694 PyErr_Format(PyExc_TypeError,
1695 "Argument given by name ('%s') "
1696 "and position (%d)",
1697 keyword, i+1);
1698 return cleanreturn(0, freelist);
1699 }
1700 }
1701 else if (nkeywords && PyErr_Occurred())
1702 return cleanreturn(0, freelist);
1703 else if (i < nargs)
1704 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimes380f7f22008-02-28 11:19:05 +00001705
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001706 if (current_arg) {
1707 msg = convertitem(current_arg, &format, p_va, flags,
1708 levels, msgbuf, sizeof(msgbuf), &freelist);
1709 if (msg) {
1710 seterror(i+1, msg, levels, fname, custom_msg);
1711 return cleanreturn(0, freelist);
1712 }
1713 continue;
1714 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001715
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001716 if (i < min) {
1717 PyErr_Format(PyExc_TypeError, "Required argument "
1718 "'%s' (pos %d) not found",
1719 keyword, i+1);
1720 return cleanreturn(0, freelist);
1721 }
1722 /* current code reports success when all required args
1723 * fulfilled and no keyword args left, with no further
1724 * validation. XXX Maybe skip this in debug build ?
1725 */
1726 if (!nkeywords)
1727 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001728
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001729 /* We are into optional args, skip thru to any remaining
1730 * keyword args */
1731 msg = skipitem(&format, p_va, flags);
1732 if (msg) {
1733 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1734 format);
1735 return cleanreturn(0, freelist);
1736 }
1737 }
Tim Petersb054be42001-10-27 05:07:41 +00001738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001739 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
1740 PyErr_Format(PyExc_RuntimeError,
1741 "more argument specifiers than keyword list entries "
1742 "(remaining format:'%s')", format);
1743 return cleanreturn(0, freelist);
1744 }
Tim Petersc2f01122001-10-27 07:25:06 +00001745
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001746 /* make sure there are no extraneous keyword arguments */
1747 if (nkeywords > 0) {
1748 PyObject *key, *value;
1749 Py_ssize_t pos = 0;
1750 while (PyDict_Next(keywords, &pos, &key, &value)) {
1751 int match = 0;
1752 char *ks;
1753 if (!PyUnicode_Check(key)) {
1754 PyErr_SetString(PyExc_TypeError,
1755 "keywords must be strings");
1756 return cleanreturn(0, freelist);
1757 }
Victor Stinner93b55132010-05-19 00:54:06 +00001758 /* check that _PyUnicode_AsString() result is not NULL */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001759 ks = _PyUnicode_AsString(key);
Victor Stinner93b55132010-05-19 00:54:06 +00001760 if (ks != NULL) {
1761 for (i = 0; i < len; i++) {
1762 if (!strcmp(ks, kwlist[i])) {
1763 match = 1;
1764 break;
1765 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001766 }
1767 }
1768 if (!match) {
1769 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001770 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001771 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001772 key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001773 return cleanreturn(0, freelist);
1774 }
1775 }
1776 }
1777
1778 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001779}
1780
1781
1782static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001783skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001784{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 const char *format = *p_format;
1786 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001787
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001788 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001789
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001790 /* simple codes
1791 * The individual types (second arg of va_arg) are irrelevant */
Georg Brandl6dd14612005-09-14 19:29:53 +00001792
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001793 case 'b': /* byte -- very short int */
1794 case 'B': /* byte as bitfield */
1795 case 'h': /* short int */
1796 case 'H': /* short int as bitfield */
1797 case 'i': /* int */
1798 case 'I': /* int sized bitfield */
1799 case 'l': /* long int */
1800 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001801#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 case 'L': /* PY_LONG_LONG */
1803 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001804#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001805 case 'f': /* float */
1806 case 'd': /* double */
1807 case 'D': /* complex double */
1808 case 'c': /* char */
1809 case 'C': /* unicode char */
1810 {
1811 (void) va_arg(*p_va, void *);
1812 break;
1813 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001814
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001815 case 'n': /* Py_ssize_t */
1816 {
1817 (void) va_arg(*p_va, Py_ssize_t *);
1818 break;
1819 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001820
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001821 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001822
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001823 case 'e': /* string with encoding */
1824 {
1825 (void) va_arg(*p_va, const char *);
1826 if (!(*format == 's' || *format == 't'))
1827 /* after 'e', only 's' and 't' is allowed */
1828 goto err;
1829 format++;
1830 /* explicit fallthrough to string cases */
1831 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001832
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001833 case 's': /* string */
1834 case 'z': /* string or None */
1835 case 'y': /* bytes */
1836 case 'u': /* unicode string */
1837 case 't': /* buffer, read-only */
1838 case 'w': /* buffer, read-write */
1839 {
1840 (void) va_arg(*p_va, char **);
1841 if (*format == '#') {
1842 if (flags & FLAG_SIZE_T)
1843 (void) va_arg(*p_va, Py_ssize_t *);
1844 else
1845 (void) va_arg(*p_va, int *);
1846 format++;
1847 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1848 format++;
1849 }
1850 break;
1851 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001852
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001853 /* object codes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001855 case 'S': /* string object */
1856 case 'Y': /* string object */
1857 case 'U': /* unicode string object */
1858 {
1859 (void) va_arg(*p_va, PyObject **);
1860 break;
1861 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001862
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001863 case 'O': /* object */
1864 {
1865 if (*format == '!') {
1866 format++;
1867 (void) va_arg(*p_va, PyTypeObject*);
1868 (void) va_arg(*p_va, PyObject **);
1869 }
1870 else if (*format == '&') {
1871 typedef int (*converter)(PyObject *, void *);
1872 (void) va_arg(*p_va, converter);
1873 (void) va_arg(*p_va, void *);
1874 format++;
1875 }
1876 else {
1877 (void) va_arg(*p_va, PyObject **);
1878 }
1879 break;
1880 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001881
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001882 case '(': /* bypass tuple, not handled at all previously */
1883 {
1884 char *msg;
1885 for (;;) {
1886 if (*format==')')
1887 break;
1888 if (IS_END_OF_FORMAT(*format))
1889 return "Unmatched left paren in format "
1890 "string";
1891 msg = skipitem(&format, p_va, flags);
1892 if (msg)
1893 return msg;
1894 }
1895 format++;
1896 break;
1897 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001898
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001899 case ')':
1900 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00001901
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001902 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001903err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001904 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001905
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001906 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001907
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001908 *p_format = format;
1909 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001910}
Fred Drakee4616e62001-10-23 21:09:29 +00001911
1912
1913int
Martin v. Löwis76246742006-03-01 04:06:10 +00001914PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001915{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001916 Py_ssize_t i, l;
1917 PyObject **o;
1918 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001919
1920#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001921 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001922#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001923 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001924#endif
1925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001926 assert(min >= 0);
1927 assert(min <= max);
1928 if (!PyTuple_Check(args)) {
1929 PyErr_SetString(PyExc_SystemError,
1930 "PyArg_UnpackTuple() argument list is not a tuple");
1931 return 0;
1932 }
1933 l = PyTuple_GET_SIZE(args);
1934 if (l < min) {
1935 if (name != NULL)
1936 PyErr_Format(
1937 PyExc_TypeError,
1938 "%s expected %s%zd arguments, got %zd",
1939 name, (min == max ? "" : "at least "), min, l);
1940 else
1941 PyErr_Format(
1942 PyExc_TypeError,
1943 "unpacked tuple should have %s%zd elements,"
1944 " but has %zd",
1945 (min == max ? "" : "at least "), min, l);
1946 va_end(vargs);
1947 return 0;
1948 }
1949 if (l > max) {
1950 if (name != NULL)
1951 PyErr_Format(
1952 PyExc_TypeError,
1953 "%s expected %s%zd arguments, got %zd",
1954 name, (min == max ? "" : "at most "), max, l);
1955 else
1956 PyErr_Format(
1957 PyExc_TypeError,
1958 "unpacked tuple should have %s%zd elements,"
1959 " but has %zd",
1960 (min == max ? "" : "at most "), max, l);
1961 va_end(vargs);
1962 return 0;
1963 }
1964 for (i = 0; i < l; i++) {
1965 o = va_arg(vargs, PyObject **);
1966 *o = PyTuple_GET_ITEM(args, i);
1967 }
1968 va_end(vargs);
1969 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001970}
Georg Brandl02c42872005-08-26 06:42:30 +00001971
1972
1973/* For type constructors that don't take keyword args
1974 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001975 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001976 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001977 */
1978int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001979_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001980{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001981 if (kw == NULL)
1982 return 1;
1983 if (!PyDict_CheckExact(kw)) {
1984 PyErr_BadInternalCall();
1985 return 0;
1986 }
1987 if (PyDict_Size(kw) == 0)
1988 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001989
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001990 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1991 funcname);
1992 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001993}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001994#ifdef __cplusplus
1995};
1996#endif