blob: bce99ae798eeb277e37ae0dee0e71d6843e248c8 [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
Guido van Rossum45aecf42006-03-15 04:58:47 +0000585/* Explicitly check for float arguments when integers are expected.
586 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000587static int
588float_argument_error(PyObject *arg)
589{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000590 if (PyFloat_Check(arg)) {
591 PyErr_SetString(PyExc_TypeError,
592 "integer argument expected, got float" );
593 return 1;
594 }
595 else
596 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000597}
598
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000599/* Convert a non-tuple argument. Return NULL if conversion went OK,
600 or a string with a message describing the failure. The message is
601 formatted as "must be <desired type>, not <actual type>".
602 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000603 Don't call if a tuple is expected.
604
605 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000606*/
607
608static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000609convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000610 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000611{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000612 /* For # codes */
613#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
614 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
615 else q=va_arg(*p_va, int*);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000616#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
617#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 const char *format = *p_format;
620 char c = *format++;
621 PyObject *uarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000622
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000623 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000624
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 case 'b': { /* unsigned byte -- very short int */
626 char *p = va_arg(*p_va, char *);
627 long ival;
628 if (float_argument_error(arg))
629 return converterr("integer<b>", arg, msgbuf, bufsize);
630 ival = PyLong_AsLong(arg);
631 if (ival == -1 && PyErr_Occurred())
632 return converterr("integer<b>", arg, msgbuf, bufsize);
633 else if (ival < 0) {
634 PyErr_SetString(PyExc_OverflowError,
635 "unsigned byte integer is less than minimum");
636 return converterr("integer<b>", arg, msgbuf, bufsize);
637 }
638 else if (ival > UCHAR_MAX) {
639 PyErr_SetString(PyExc_OverflowError,
640 "unsigned byte integer is greater than maximum");
641 return converterr("integer<b>", arg, msgbuf, bufsize);
642 }
643 else
644 *p = (unsigned char) ival;
645 break;
646 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000648 case 'B': {/* byte sized bitfield - both signed and unsigned
649 values allowed */
650 char *p = va_arg(*p_va, char *);
651 long ival;
652 if (float_argument_error(arg))
653 return converterr("integer<B>", arg, msgbuf, bufsize);
654 ival = PyLong_AsUnsignedLongMask(arg);
655 if (ival == -1 && PyErr_Occurred())
656 return converterr("integer<B>", arg, msgbuf, bufsize);
657 else
658 *p = (unsigned char) ival;
659 break;
660 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000662 case 'h': {/* signed short int */
663 short *p = va_arg(*p_va, short *);
664 long ival;
665 if (float_argument_error(arg))
666 return converterr("integer<h>", arg, msgbuf, bufsize);
667 ival = PyLong_AsLong(arg);
668 if (ival == -1 && PyErr_Occurred())
669 return converterr("integer<h>", arg, msgbuf, bufsize);
670 else if (ival < SHRT_MIN) {
671 PyErr_SetString(PyExc_OverflowError,
672 "signed short integer is less than minimum");
673 return converterr("integer<h>", arg, msgbuf, bufsize);
674 }
675 else if (ival > SHRT_MAX) {
676 PyErr_SetString(PyExc_OverflowError,
677 "signed short integer is greater than maximum");
678 return converterr("integer<h>", arg, msgbuf, bufsize);
679 }
680 else
681 *p = (short) ival;
682 break;
683 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000685 case 'H': { /* short int sized bitfield, both signed and
686 unsigned allowed */
687 unsigned short *p = va_arg(*p_va, unsigned short *);
688 long ival;
689 if (float_argument_error(arg))
690 return converterr("integer<H>", arg, msgbuf, bufsize);
691 ival = PyLong_AsUnsignedLongMask(arg);
692 if (ival == -1 && PyErr_Occurred())
693 return converterr("integer<H>", arg, msgbuf, bufsize);
694 else
695 *p = (unsigned short) ival;
696 break;
697 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 case 'i': {/* signed int */
700 int *p = va_arg(*p_va, int *);
701 long ival;
702 if (float_argument_error(arg))
703 return converterr("integer<i>", arg, msgbuf, bufsize);
704 ival = PyLong_AsLong(arg);
705 if (ival == -1 && PyErr_Occurred())
706 return converterr("integer<i>", arg, msgbuf, bufsize);
707 else if (ival > INT_MAX) {
708 PyErr_SetString(PyExc_OverflowError,
709 "signed integer is greater than maximum");
710 return converterr("integer<i>", arg, msgbuf, bufsize);
711 }
712 else if (ival < INT_MIN) {
713 PyErr_SetString(PyExc_OverflowError,
714 "signed integer is less than minimum");
715 return converterr("integer<i>", arg, msgbuf, bufsize);
716 }
717 else
718 *p = ival;
719 break;
720 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000721
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000722 case 'I': { /* int sized bitfield, both signed and
723 unsigned allowed */
724 unsigned int *p = va_arg(*p_va, unsigned int *);
725 unsigned int ival;
726 if (float_argument_error(arg))
727 return converterr("integer<I>", arg, msgbuf, bufsize);
728 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
729 if (ival == (unsigned int)-1 && PyErr_Occurred())
730 return converterr("integer<I>", arg, msgbuf, bufsize);
731 else
732 *p = ival;
733 break;
734 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 case 'n': /* Py_ssize_t */
737 {
738 PyObject *iobj;
739 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
740 Py_ssize_t ival = -1;
741 if (float_argument_error(arg))
742 return converterr("integer<n>", arg, msgbuf, bufsize);
743 iobj = PyNumber_Index(arg);
744 if (iobj != NULL) {
745 ival = PyLong_AsSsize_t(iobj);
746 Py_DECREF(iobj);
747 }
748 if (ival == -1 && PyErr_Occurred())
749 return converterr("integer<n>", arg, msgbuf, bufsize);
750 *p = ival;
751 break;
752 }
753 case 'l': {/* long int */
754 long *p = va_arg(*p_va, long *);
755 long ival;
756 if (float_argument_error(arg))
757 return converterr("integer<l>", arg, msgbuf, bufsize);
758 ival = PyLong_AsLong(arg);
759 if (ival == -1 && PyErr_Occurred())
760 return converterr("integer<l>", arg, msgbuf, bufsize);
761 else
762 *p = ival;
763 break;
764 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000765
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000766 case 'k': { /* long sized bitfield */
767 unsigned long *p = va_arg(*p_va, unsigned long *);
768 unsigned long ival;
769 if (PyLong_Check(arg))
770 ival = PyLong_AsUnsignedLongMask(arg);
771 else
772 return converterr("integer<k>", arg, msgbuf, bufsize);
773 *p = ival;
774 break;
775 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000776
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000777#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 case 'L': {/* PY_LONG_LONG */
779 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
780 PY_LONG_LONG ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000781 if (float_argument_error(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000782 return converterr("long<L>", arg, msgbuf, bufsize);
783 ival = PyLong_AsLongLong(arg);
Mark Dickinsonc7301312010-06-10 16:05:10 +0000784 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred())
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000785 return converterr("long<L>", arg, msgbuf, bufsize);
Mark Dickinsonc7301312010-06-10 16:05:10 +0000786 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000788 break;
789 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000791 case 'K': { /* long long sized bitfield */
792 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
793 unsigned PY_LONG_LONG ival;
794 if (PyLong_Check(arg))
795 ival = PyLong_AsUnsignedLongLongMask(arg);
796 else
797 return converterr("integer<K>", arg, msgbuf, bufsize);
798 *p = ival;
799 break;
800 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000801#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 case 'f': {/* float */
804 float *p = va_arg(*p_va, float *);
805 double dval = PyFloat_AsDouble(arg);
806 if (PyErr_Occurred())
807 return converterr("float<f>", arg, msgbuf, bufsize);
808 else
809 *p = (float) dval;
810 break;
811 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000812
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 case 'd': {/* double */
814 double *p = va_arg(*p_va, double *);
815 double dval = PyFloat_AsDouble(arg);
816 if (PyErr_Occurred())
817 return converterr("float<d>", arg, msgbuf, bufsize);
818 else
819 *p = dval;
820 break;
821 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000822
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 case 'D': {/* complex double */
824 Py_complex *p = va_arg(*p_va, Py_complex *);
825 Py_complex cval;
826 cval = PyComplex_AsCComplex(arg);
827 if (PyErr_Occurred())
828 return converterr("complex<D>", arg, msgbuf, bufsize);
829 else
830 *p = cval;
831 break;
832 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000833
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000834 case 'c': {/* char */
835 char *p = va_arg(*p_va, char *);
836 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
837 *p = PyBytes_AS_STRING(arg)[0];
838 else
839 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
840 break;
841 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000842
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 case 'C': {/* unicode char */
844 int *p = va_arg(*p_va, int *);
845 if (PyUnicode_Check(arg) &&
846 PyUnicode_GET_SIZE(arg) == 1)
847 *p = PyUnicode_AS_UNICODE(arg)[0];
848 else
849 return converterr("a unicode character", arg, msgbuf, bufsize);
850 break;
851 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000852
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000853 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000854 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000855
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 case 's': {/* text string */
857 if (*format == '*') {
858 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000859
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000860 if (PyUnicode_Check(arg)) {
861 uarg = UNICODE_DEFAULT_ENCODING(arg);
862 if (uarg == NULL)
863 return converterr(CONV_UNICODE,
864 arg, msgbuf, bufsize);
865 PyBuffer_FillInfo(p, arg,
866 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
867 1, 0);
868 }
869 else { /* any buffer-like object */
870 char *buf;
871 if (getbuffer(arg, p, &buf) < 0)
872 return converterr(buf, arg, msgbuf, bufsize);
873 }
874 if (addcleanup(p, freelist, cleanup_buffer)) {
875 return converterr(
876 "(cleanup problem)",
877 arg, msgbuf, bufsize);
878 }
879 format++;
880 } else if (*format == '#') {
881 void **p = (void **)va_arg(*p_va, char **);
882 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 if (PyUnicode_Check(arg)) {
885 uarg = UNICODE_DEFAULT_ENCODING(arg);
886 if (uarg == NULL)
887 return converterr(CONV_UNICODE,
888 arg, msgbuf, bufsize);
889 *p = PyBytes_AS_STRING(uarg);
890 STORE_SIZE(PyBytes_GET_SIZE(uarg));
891 }
892 else { /* any buffer-like object */
893 /* XXX Really? */
894 char *buf;
895 Py_ssize_t count = convertbuffer(arg, p, &buf);
896 if (count < 0)
897 return converterr(buf, arg, msgbuf, bufsize);
898 STORE_SIZE(count);
899 }
900 format++;
901 } else {
902 char **p = va_arg(*p_va, char **);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000903
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000904 if (PyUnicode_Check(arg)) {
905 uarg = UNICODE_DEFAULT_ENCODING(arg);
906 if (uarg == NULL)
907 return converterr(CONV_UNICODE,
908 arg, msgbuf, bufsize);
909 *p = PyBytes_AS_STRING(uarg);
910 }
911 else
912 return converterr("string", arg, msgbuf, bufsize);
913 if ((Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
914 return converterr("string without null bytes",
915 arg, msgbuf, bufsize);
916 }
917 break;
918 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000919
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000920 case 'y': {/* any buffer-like object, but not PyUnicode */
921 void **p = (void **)va_arg(*p_va, char **);
922 char *buf;
923 Py_ssize_t count;
924 if (*format == '*') {
925 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
926 return converterr(buf, arg, msgbuf, bufsize);
927 format++;
928 if (addcleanup(p, freelist, cleanup_buffer)) {
929 return converterr(
930 "(cleanup problem)",
931 arg, msgbuf, bufsize);
932 }
933 break;
934 }
935 count = convertbuffer(arg, p, &buf);
936 if (count < 0)
937 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000938 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000939 FETCH_SIZE;
940 STORE_SIZE(count);
941 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000942 } else {
943 if (strlen(*p) != count)
944 return converterr(
945 "bytes without null bytes",
946 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000947 }
948 break;
949 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000950
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 case 'z': {/* like 's' or 's#', but None is okay, stored as NULL */
952 if (*format == '*') {
953 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000954
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 if (arg == Py_None)
956 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
957 else if (PyUnicode_Check(arg)) {
958 uarg = UNICODE_DEFAULT_ENCODING(arg);
959 if (uarg == NULL)
960 return converterr(CONV_UNICODE,
961 arg, msgbuf, bufsize);
962 PyBuffer_FillInfo(p, arg,
963 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
964 1, 0);
965 }
966 else { /* any buffer-like object */
967 char *buf;
968 if (getbuffer(arg, p, &buf) < 0)
969 return converterr(buf, arg, msgbuf, bufsize);
970 }
971 if (addcleanup(p, freelist, cleanup_buffer)) {
972 return converterr(
973 "(cleanup problem)",
974 arg, msgbuf, bufsize);
975 }
976 format++;
977 } else if (*format == '#') { /* any buffer-like object */
978 void **p = (void **)va_arg(*p_va, char **);
979 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000980
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 if (arg == Py_None) {
982 *p = 0;
983 STORE_SIZE(0);
984 }
985 else if (PyUnicode_Check(arg)) {
986 uarg = UNICODE_DEFAULT_ENCODING(arg);
987 if (uarg == NULL)
988 return converterr(CONV_UNICODE,
989 arg, msgbuf, bufsize);
990 *p = PyBytes_AS_STRING(uarg);
991 STORE_SIZE(PyBytes_GET_SIZE(uarg));
992 }
993 else { /* any buffer-like object */
994 /* XXX Really? */
995 char *buf;
996 Py_ssize_t count = convertbuffer(arg, p, &buf);
997 if (count < 0)
998 return converterr(buf, arg, msgbuf, bufsize);
999 STORE_SIZE(count);
1000 }
1001 format++;
1002 } else {
1003 char **p = va_arg(*p_va, char **);
1004 uarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001005
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001006 if (arg == Py_None)
1007 *p = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001008 else if (PyUnicode_Check(arg)) {
1009 uarg = UNICODE_DEFAULT_ENCODING(arg);
1010 if (uarg == NULL)
1011 return converterr(CONV_UNICODE,
1012 arg, msgbuf, bufsize);
1013 *p = PyBytes_AS_STRING(uarg);
1014 }
1015 else
1016 return converterr("string or None",
1017 arg, msgbuf, bufsize);
Victor Stinner43fb0092010-05-29 00:13:06 +00001018 if (*p != NULL && uarg != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001019 (Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
1020 return converterr(
1021 "string without null bytes or None",
1022 arg, msgbuf, bufsize);
1023 }
1024 break;
1025 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 case 'Z': {/* unicode, may be NULL (None) */
1028 if (*format == '#') { /* any buffer-like object */
1029 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1030 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001031
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001032 if (arg == Py_None) {
1033 *p = 0;
1034 STORE_SIZE(0);
1035 }
1036 else if (PyUnicode_Check(arg)) {
1037 *p = PyUnicode_AS_UNICODE(arg);
1038 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1039 }
Victor Stinner5216e6d2010-06-08 21:45:51 +00001040 else
1041 return converterr("str or None", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001042 format++;
1043 } else {
1044 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 if (arg == Py_None)
1047 *p = 0;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001048 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001049 *p = PyUnicode_AS_UNICODE(arg);
Victor Stinner06e49dd2010-06-13 18:21:50 +00001050 if (Py_UNICODE_strlen(*p) != PyUnicode_GET_SIZE(arg))
1051 return converterr(
1052 "str without null character or None",
1053 arg, msgbuf, bufsize);
1054 } else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001055 return converterr("str or None", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001056 }
1057 break;
1058 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001060 case 'e': {/* encoded string */
1061 char **buffer;
1062 const char *encoding;
1063 PyObject *s;
1064 int recode_strings;
1065 Py_ssize_t size;
1066 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001067
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001068 /* Get 'e' parameter: the encoding name */
1069 encoding = (const char *)va_arg(*p_va, const char *);
1070 if (encoding == NULL)
1071 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001072
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001073 /* Get output buffer parameter:
1074 's' (recode all objects via Unicode) or
1075 't' (only recode non-string objects)
1076 */
1077 if (*format == 's')
1078 recode_strings = 1;
1079 else if (*format == 't')
1080 recode_strings = 0;
1081 else
1082 return converterr(
1083 "(unknown parser marker combination)",
1084 arg, msgbuf, bufsize);
1085 buffer = (char **)va_arg(*p_va, char **);
1086 format++;
1087 if (buffer == NULL)
1088 return converterr("(buffer is NULL)",
1089 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001090
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001091 /* Encode object */
1092 if (!recode_strings &&
1093 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1094 s = arg;
1095 Py_INCREF(s);
1096 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1097 return converterr("(AsCharBuffer failed)",
1098 arg, msgbuf, bufsize);
1099 }
1100 else {
1101 PyObject *u;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001103 /* Convert object to Unicode */
1104 u = PyUnicode_FromObject(arg);
1105 if (u == NULL)
1106 return converterr(
1107 "string or unicode or text buffer",
1108 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001109
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001110 /* Encode object; use default error handling */
1111 s = PyUnicode_AsEncodedString(u,
1112 encoding,
1113 NULL);
1114 Py_DECREF(u);
1115 if (s == NULL)
1116 return converterr("(encoding failed)",
1117 arg, msgbuf, bufsize);
1118 if (!PyBytes_Check(s)) {
1119 Py_DECREF(s);
1120 return converterr(
1121 "(encoder failed to return bytes)",
1122 arg, msgbuf, bufsize);
1123 }
1124 size = PyBytes_GET_SIZE(s);
1125 ptr = PyBytes_AS_STRING(s);
1126 if (ptr == NULL)
1127 ptr = "";
1128 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001129
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001130 /* Write output; output is guaranteed to be 0-terminated */
1131 if (*format == '#') {
1132 /* Using buffer length parameter '#':
1133
1134 - if *buffer is NULL, a new buffer of the
1135 needed size is allocated and the data
1136 copied into it; *buffer is updated to point
1137 to the new buffer; the caller is
1138 responsible for PyMem_Free()ing it after
1139 usage
1140
1141 - if *buffer is not NULL, the data is
1142 copied to *buffer; *buffer_len has to be
1143 set to the size of the buffer on input;
1144 buffer overflow is signalled with an error;
1145 buffer has to provide enough room for the
1146 encoded string plus the trailing 0-byte
1147
1148 - in both cases, *buffer_len is updated to
1149 the size of the buffer /excluding/ the
1150 trailing 0-byte
1151
1152 */
1153 FETCH_SIZE;
1154
1155 format++;
1156 if (q == NULL && q2 == NULL) {
1157 Py_DECREF(s);
1158 return converterr(
1159 "(buffer_len is NULL)",
1160 arg, msgbuf, bufsize);
1161 }
1162 if (*buffer == NULL) {
1163 *buffer = PyMem_NEW(char, size + 1);
1164 if (*buffer == NULL) {
1165 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001166 PyErr_NoMemory();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001167 return converterr(
1168 "(memory error)",
1169 arg, msgbuf, bufsize);
1170 }
1171 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1172 Py_DECREF(s);
1173 return converterr(
1174 "(cleanup problem)",
1175 arg, msgbuf, bufsize);
1176 }
1177 } else {
1178 if (size + 1 > BUFFER_LEN) {
1179 Py_DECREF(s);
1180 return converterr(
1181 "(buffer overflow)",
1182 arg, msgbuf, bufsize);
1183 }
1184 }
1185 memcpy(*buffer, ptr, size+1);
1186 STORE_SIZE(size);
1187 } else {
1188 /* Using a 0-terminated buffer:
1189
1190 - the encoded string has to be 0-terminated
1191 for this variant to work; if it is not, an
1192 error raised
1193
1194 - a new buffer of the needed size is
1195 allocated and the data copied into it;
1196 *buffer is updated to point to the new
1197 buffer; the caller is responsible for
1198 PyMem_Free()ing it after usage
1199
1200 */
1201 if ((Py_ssize_t)strlen(ptr) != size) {
1202 Py_DECREF(s);
1203 return converterr(
1204 "encoded string without NULL bytes",
1205 arg, msgbuf, bufsize);
1206 }
1207 *buffer = PyMem_NEW(char, size + 1);
1208 if (*buffer == NULL) {
1209 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001210 PyErr_NoMemory();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001211 return converterr("(memory error)",
1212 arg, msgbuf, bufsize);
1213 }
1214 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1215 Py_DECREF(s);
1216 return converterr("(cleanup problem)",
1217 arg, msgbuf, bufsize);
1218 }
1219 memcpy(*buffer, ptr, size+1);
1220 }
1221 Py_DECREF(s);
1222 break;
1223 }
1224
1225 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1226 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1227 if (!PyUnicode_Check(arg))
1228 return converterr("str", arg, msgbuf, bufsize);
1229 *p = PyUnicode_AS_UNICODE(arg);
1230 if (*format == '#') { /* store pointer and size */
1231 FETCH_SIZE;
1232 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1233 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001234 } else {
1235 if (Py_UNICODE_strlen(*p) != PyUnicode_GET_SIZE(arg))
1236 return converterr(
1237 "str without null character",
1238 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001239 }
1240 break;
1241 }
1242
1243 case 'S': { /* PyBytes object */
1244 PyObject **p = va_arg(*p_va, PyObject **);
1245 if (PyBytes_Check(arg))
1246 *p = arg;
1247 else
1248 return converterr("bytes", arg, msgbuf, bufsize);
1249 break;
1250 }
1251
1252 case 'Y': { /* PyByteArray object */
1253 PyObject **p = va_arg(*p_va, PyObject **);
1254 if (PyByteArray_Check(arg))
1255 *p = arg;
1256 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001257 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001258 break;
1259 }
1260
1261 case 'U': { /* PyUnicode object */
1262 PyObject **p = va_arg(*p_va, PyObject **);
1263 if (PyUnicode_Check(arg))
1264 *p = arg;
1265 else
1266 return converterr("str", arg, msgbuf, bufsize);
1267 break;
1268 }
1269
1270 case 'O': { /* object */
1271 PyTypeObject *type;
1272 PyObject **p;
1273 if (*format == '!') {
1274 type = va_arg(*p_va, PyTypeObject*);
1275 p = va_arg(*p_va, PyObject **);
1276 format++;
1277 if (PyType_IsSubtype(arg->ob_type, type))
1278 *p = arg;
1279 else
1280 return converterr(type->tp_name, arg, msgbuf, bufsize);
1281
1282 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001283 else if (*format == '&') {
1284 typedef int (*converter)(PyObject *, void *);
1285 converter convert = va_arg(*p_va, converter);
1286 void *addr = va_arg(*p_va, void *);
1287 int res;
1288 format++;
1289 if (! (res = (*convert)(arg, addr)))
1290 return converterr("(unspecified)",
1291 arg, msgbuf, bufsize);
1292 if (res == Py_CLEANUP_SUPPORTED &&
1293 addcleanup_convert(addr, freelist, convert) == -1)
1294 return converterr("(cleanup problem)",
1295 arg, msgbuf, bufsize);
1296 }
1297 else {
1298 p = va_arg(*p_va, PyObject **);
1299 *p = arg;
1300 }
1301 break;
1302 }
1303
1304
1305 case 'w': { /* memory buffer, read-write access */
1306 void **p = va_arg(*p_va, void **);
1307 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1308 Py_ssize_t count;
1309 int temp=-1;
1310 Py_buffer view;
1311
1312 if (pb && pb->bf_releasebuffer && *format != '*')
1313 /* Buffer must be released, yet caller does not use
1314 the Py_buffer protocol. */
1315 return converterr("pinned buffer", arg, msgbuf, bufsize);
1316
1317
1318 if (pb && pb->bf_getbuffer && *format == '*') {
1319 /* Caller is interested in Py_buffer, and the object
1320 supports it directly. */
1321 format++;
1322 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1323 PyErr_Clear();
1324 return converterr("read-write buffer", arg, msgbuf, bufsize);
1325 }
1326 if (addcleanup(p, freelist, cleanup_buffer)) {
1327 return converterr(
1328 "(cleanup problem)",
1329 arg, msgbuf, bufsize);
1330 }
1331 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C'))
1332 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1333 break;
1334 }
1335
1336 /* Here we have processed w*, only w and w# remain. */
1337 if (pb == NULL ||
1338 pb->bf_getbuffer == NULL ||
1339 ((temp = PyObject_GetBuffer(arg, &view,
1340 PyBUF_SIMPLE)) != 0) ||
1341 view.readonly == 1) {
1342 if (temp==0) {
1343 PyBuffer_Release(&view);
1344 }
1345 return converterr("single-segment read-write buffer",
1346 arg, msgbuf, bufsize);
1347 }
1348
1349 if ((count = view.len) < 0)
1350 return converterr("(unspecified)", arg, msgbuf, bufsize);
1351 *p = view.buf;
1352 if (*format == '#') {
1353 FETCH_SIZE;
1354 STORE_SIZE(count);
1355 format++;
1356 }
1357 break;
1358 }
1359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001360 default:
1361 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
1362
1363 }
1364
1365 *p_format = format;
1366 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001367}
Guido van Rossumaa354651996-08-19 19:32:04 +00001368
Martin v. Löwis18e16552006-02-15 17:27:45 +00001369static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001370convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001371{
Victor Stinner5cb62392010-06-06 20:27:51 +00001372 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001373 Py_ssize_t count;
1374 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001375
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001376 *errmsg = NULL;
1377 *p = NULL;
1378 if (pb == NULL ||
1379 pb->bf_getbuffer == NULL ||
1380 pb->bf_releasebuffer != NULL) {
1381 *errmsg = "bytes or read-only buffer";
1382 return -1;
1383 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001384
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001385 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0) {
1386 *errmsg = "bytes or single-segment read-only buffer";
1387 return -1;
1388 }
1389 count = view.len;
1390 *p = view.buf;
1391 PyBuffer_Release(&view);
1392 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001393}
Guido van Rossumaa354651996-08-19 19:32:04 +00001394
Martin v. Löwis423be952008-08-13 15:53:07 +00001395/* XXX for 3.x, getbuffer and convertbuffer can probably
1396 be merged again. */
1397static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001398getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001399{
Victor Stinner5cb62392010-06-06 20:27:51 +00001400 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001401 if (pb == NULL) {
1402 *errmsg = "bytes or buffer";
1403 return -1;
1404 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001405 if (pb->bf_getbuffer == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001406 *errmsg = "convertible to a buffer";
Victor Stinner5cb62392010-06-06 20:27:51 +00001407 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001408 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001409 if (PyObject_GetBuffer(arg, view, 0) < 0) {
1410 *errmsg = "convertible to a buffer";
1411 return -1;
1412 }
1413 if (!PyBuffer_IsContiguous(view, 'C')) {
1414 *errmsg = "contiguous buffer";
1415 return -1;
1416 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001418}
1419
Guido van Rossumaa354651996-08-19 19:32:04 +00001420/* Support for keyword arguments donated by
1421 Geoff Philbrick <philbric@delphi.hks.com> */
1422
Tim Petersf8cd3e82001-10-27 04:26:57 +00001423/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001424int
1425PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001426 PyObject *keywords,
1427 const char *format,
1428 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001429{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 int retval;
1431 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 if ((args == NULL || !PyTuple_Check(args)) ||
1434 (keywords != NULL && !PyDict_Check(keywords)) ||
1435 format == NULL ||
1436 kwlist == NULL)
1437 {
1438 PyErr_BadInternalCall();
1439 return 0;
1440 }
Tim Peters45772cd2001-10-27 03:58:40 +00001441
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 va_start(va, kwlist);
1443 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1444 va_end(va);
1445 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001446}
1447
1448int
1449_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 PyObject *keywords,
1451 const char *format,
1452 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001453{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 int retval;
1455 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001456
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001457 if ((args == NULL || !PyTuple_Check(args)) ||
1458 (keywords != NULL && !PyDict_Check(keywords)) ||
1459 format == NULL ||
1460 kwlist == NULL)
1461 {
1462 PyErr_BadInternalCall();
1463 return 0;
1464 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 va_start(va, kwlist);
1467 retval = vgetargskeywords(args, keywords, format,
1468 kwlist, &va, FLAG_SIZE_T);
1469 va_end(va);
1470 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001471}
1472
1473
Brett Cannon711e7d92004-07-10 22:20:32 +00001474int
1475PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001476 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001477 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001478 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001479{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 int retval;
1481 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001482
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001483 if ((args == NULL || !PyTuple_Check(args)) ||
1484 (keywords != NULL && !PyDict_Check(keywords)) ||
1485 format == NULL ||
1486 kwlist == NULL)
1487 {
1488 PyErr_BadInternalCall();
1489 return 0;
1490 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001491
1492#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 memcpy(lva, va, sizeof(va_list));
Brett Cannon711e7d92004-07-10 22:20:32 +00001494#else
1495#ifdef __va_copy
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 __va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001497#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 lva = va;
Brett Cannon711e7d92004-07-10 22:20:32 +00001499#endif
1500#endif
1501
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001502 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1503 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001504}
1505
1506int
1507_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 PyObject *keywords,
1509 const char *format,
1510 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001511{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001512 int retval;
1513 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001514
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001515 if ((args == NULL || !PyTuple_Check(args)) ||
1516 (keywords != NULL && !PyDict_Check(keywords)) ||
1517 format == NULL ||
1518 kwlist == NULL)
1519 {
1520 PyErr_BadInternalCall();
1521 return 0;
1522 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001523
1524#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 memcpy(lva, va, sizeof(va_list));
Martin v. Löwis18e16552006-02-15 17:27:45 +00001526#else
1527#ifdef __va_copy
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001528 __va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001529#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001530 lva = va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001531#endif
1532#endif
1533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001534 retval = vgetargskeywords(args, keywords, format,
1535 kwlist, &lva, FLAG_SIZE_T);
1536 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001537}
1538
Benjamin Petersonfb886362010-04-24 18:21:17 +00001539int
1540PyArg_ValidateKeywordArguments(PyObject *kwargs)
1541{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 if (!PyDict_CheckExact(kwargs)) {
1543 PyErr_BadInternalCall();
1544 return 0;
1545 }
1546 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1547 PyErr_SetString(PyExc_TypeError,
1548 "keyword arguments must be strings");
1549 return 0;
1550 }
1551 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001552}
1553
Christian Heimes380f7f22008-02-28 11:19:05 +00001554#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001555
Guido van Rossumaa354651996-08-19 19:32:04 +00001556static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001557vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001559{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001560 char msgbuf[512];
1561 int levels[32];
1562 const char *fname, *msg, *custom_msg, *keyword;
1563 int min = INT_MAX;
1564 int i, len, nargs, nkeywords;
1565 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 assert(args != NULL && PyTuple_Check(args));
1568 assert(keywords == NULL || PyDict_Check(keywords));
1569 assert(format != NULL);
1570 assert(kwlist != NULL);
1571 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001572
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001573 /* grab the function name or custom error msg first (mutually exclusive) */
1574 fname = strchr(format, ':');
1575 if (fname) {
1576 fname++;
1577 custom_msg = NULL;
1578 }
1579 else {
1580 custom_msg = strchr(format,';');
1581 if (custom_msg)
1582 custom_msg++;
1583 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001584
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 /* scan kwlist and get greatest possible nbr of args */
1586 for (len=0; kwlist[len]; len++)
1587 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 nargs = PyTuple_GET_SIZE(args);
1590 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1591 if (nargs + nkeywords > len) {
1592 PyErr_Format(PyExc_TypeError, "%s%s takes at most %d "
1593 "argument%s (%d given)",
1594 (fname == NULL) ? "function" : fname,
1595 (fname == NULL) ? "" : "()",
1596 len,
1597 (len == 1) ? "" : "s",
1598 nargs + nkeywords);
1599 return 0;
1600 }
Tim Petersc2f01122001-10-27 07:25:06 +00001601
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1603 for (i = 0; i < len; i++) {
1604 keyword = kwlist[i];
1605 if (*format == '|') {
1606 min = i;
1607 format++;
1608 }
1609 if (IS_END_OF_FORMAT(*format)) {
1610 PyErr_Format(PyExc_RuntimeError,
1611 "More keyword list entries (%d) than "
1612 "format specifiers (%d)", len, i);
1613 return cleanreturn(0, freelist);
1614 }
1615 current_arg = NULL;
1616 if (nkeywords) {
1617 current_arg = PyDict_GetItemString(keywords, keyword);
1618 }
1619 if (current_arg) {
1620 --nkeywords;
1621 if (i < nargs) {
1622 /* arg present in tuple and in dict */
1623 PyErr_Format(PyExc_TypeError,
1624 "Argument given by name ('%s') "
1625 "and position (%d)",
1626 keyword, i+1);
1627 return cleanreturn(0, freelist);
1628 }
1629 }
1630 else if (nkeywords && PyErr_Occurred())
1631 return cleanreturn(0, freelist);
1632 else if (i < nargs)
1633 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimes380f7f22008-02-28 11:19:05 +00001634
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001635 if (current_arg) {
1636 msg = convertitem(current_arg, &format, p_va, flags,
1637 levels, msgbuf, sizeof(msgbuf), &freelist);
1638 if (msg) {
1639 seterror(i+1, msg, levels, fname, custom_msg);
1640 return cleanreturn(0, freelist);
1641 }
1642 continue;
1643 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 if (i < min) {
1646 PyErr_Format(PyExc_TypeError, "Required argument "
1647 "'%s' (pos %d) not found",
1648 keyword, i+1);
1649 return cleanreturn(0, freelist);
1650 }
1651 /* current code reports success when all required args
1652 * fulfilled and no keyword args left, with no further
1653 * validation. XXX Maybe skip this in debug build ?
1654 */
1655 if (!nkeywords)
1656 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 /* We are into optional args, skip thru to any remaining
1659 * keyword args */
1660 msg = skipitem(&format, p_va, flags);
1661 if (msg) {
1662 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1663 format);
1664 return cleanreturn(0, freelist);
1665 }
1666 }
Tim Petersb054be42001-10-27 05:07:41 +00001667
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001668 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
1669 PyErr_Format(PyExc_RuntimeError,
1670 "more argument specifiers than keyword list entries "
1671 "(remaining format:'%s')", format);
1672 return cleanreturn(0, freelist);
1673 }
Tim Petersc2f01122001-10-27 07:25:06 +00001674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 /* make sure there are no extraneous keyword arguments */
1676 if (nkeywords > 0) {
1677 PyObject *key, *value;
1678 Py_ssize_t pos = 0;
1679 while (PyDict_Next(keywords, &pos, &key, &value)) {
1680 int match = 0;
1681 char *ks;
1682 if (!PyUnicode_Check(key)) {
1683 PyErr_SetString(PyExc_TypeError,
1684 "keywords must be strings");
1685 return cleanreturn(0, freelist);
1686 }
Victor Stinner93b55132010-05-19 00:54:06 +00001687 /* check that _PyUnicode_AsString() result is not NULL */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001688 ks = _PyUnicode_AsString(key);
Victor Stinner93b55132010-05-19 00:54:06 +00001689 if (ks != NULL) {
1690 for (i = 0; i < len; i++) {
1691 if (!strcmp(ks, kwlist[i])) {
1692 match = 1;
1693 break;
1694 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 }
1696 }
1697 if (!match) {
1698 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001699 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001700 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001701 key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001702 return cleanreturn(0, freelist);
1703 }
1704 }
1705 }
1706
1707 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001708}
1709
1710
1711static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001712skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001713{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001714 const char *format = *p_format;
1715 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001716
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001717 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001718
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001719 /* simple codes
1720 * The individual types (second arg of va_arg) are irrelevant */
Georg Brandl6dd14612005-09-14 19:29:53 +00001721
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001722 case 'b': /* byte -- very short int */
1723 case 'B': /* byte as bitfield */
1724 case 'h': /* short int */
1725 case 'H': /* short int as bitfield */
1726 case 'i': /* int */
1727 case 'I': /* int sized bitfield */
1728 case 'l': /* long int */
1729 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001730#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001731 case 'L': /* PY_LONG_LONG */
1732 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001733#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734 case 'f': /* float */
1735 case 'd': /* double */
1736 case 'D': /* complex double */
1737 case 'c': /* char */
1738 case 'C': /* unicode char */
1739 {
1740 (void) va_arg(*p_va, void *);
1741 break;
1742 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001743
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001744 case 'n': /* Py_ssize_t */
1745 {
1746 (void) va_arg(*p_va, Py_ssize_t *);
1747 break;
1748 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001749
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001750 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001751
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001752 case 'e': /* string with encoding */
1753 {
1754 (void) va_arg(*p_va, const char *);
1755 if (!(*format == 's' || *format == 't'))
1756 /* after 'e', only 's' and 't' is allowed */
1757 goto err;
1758 format++;
1759 /* explicit fallthrough to string cases */
1760 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001761
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001762 case 's': /* string */
1763 case 'z': /* string or None */
1764 case 'y': /* bytes */
1765 case 'u': /* unicode string */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001766 case 'w': /* buffer, read-write */
1767 {
1768 (void) va_arg(*p_va, char **);
1769 if (*format == '#') {
1770 if (flags & FLAG_SIZE_T)
1771 (void) va_arg(*p_va, Py_ssize_t *);
1772 else
1773 (void) va_arg(*p_va, int *);
1774 format++;
1775 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1776 format++;
1777 }
1778 break;
1779 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001780
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001781 /* object codes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001782
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001783 case 'S': /* string object */
1784 case 'Y': /* string object */
1785 case 'U': /* unicode string object */
1786 {
1787 (void) va_arg(*p_va, PyObject **);
1788 break;
1789 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001791 case 'O': /* object */
1792 {
1793 if (*format == '!') {
1794 format++;
1795 (void) va_arg(*p_va, PyTypeObject*);
1796 (void) va_arg(*p_va, PyObject **);
1797 }
1798 else if (*format == '&') {
1799 typedef int (*converter)(PyObject *, void *);
1800 (void) va_arg(*p_va, converter);
1801 (void) va_arg(*p_va, void *);
1802 format++;
1803 }
1804 else {
1805 (void) va_arg(*p_va, PyObject **);
1806 }
1807 break;
1808 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001809
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001810 case '(': /* bypass tuple, not handled at all previously */
1811 {
1812 char *msg;
1813 for (;;) {
1814 if (*format==')')
1815 break;
1816 if (IS_END_OF_FORMAT(*format))
1817 return "Unmatched left paren in format "
1818 "string";
1819 msg = skipitem(&format, p_va, flags);
1820 if (msg)
1821 return msg;
1822 }
1823 format++;
1824 break;
1825 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001826
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001827 case ')':
1828 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00001829
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001830 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001831err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001832 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001833
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001834 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001835
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001836 *p_format = format;
1837 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001838}
Fred Drakee4616e62001-10-23 21:09:29 +00001839
1840
1841int
Martin v. Löwis76246742006-03-01 04:06:10 +00001842PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001843{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001844 Py_ssize_t i, l;
1845 PyObject **o;
1846 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001847
1848#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001849 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001850#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001851 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001852#endif
1853
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001854 assert(min >= 0);
1855 assert(min <= max);
1856 if (!PyTuple_Check(args)) {
1857 PyErr_SetString(PyExc_SystemError,
1858 "PyArg_UnpackTuple() argument list is not a tuple");
1859 return 0;
1860 }
1861 l = PyTuple_GET_SIZE(args);
1862 if (l < min) {
1863 if (name != NULL)
1864 PyErr_Format(
1865 PyExc_TypeError,
1866 "%s expected %s%zd arguments, got %zd",
1867 name, (min == max ? "" : "at least "), min, l);
1868 else
1869 PyErr_Format(
1870 PyExc_TypeError,
1871 "unpacked tuple should have %s%zd elements,"
1872 " but has %zd",
1873 (min == max ? "" : "at least "), min, l);
1874 va_end(vargs);
1875 return 0;
1876 }
1877 if (l > max) {
1878 if (name != NULL)
1879 PyErr_Format(
1880 PyExc_TypeError,
1881 "%s expected %s%zd arguments, got %zd",
1882 name, (min == max ? "" : "at most "), max, l);
1883 else
1884 PyErr_Format(
1885 PyExc_TypeError,
1886 "unpacked tuple should have %s%zd elements,"
1887 " but has %zd",
1888 (min == max ? "" : "at most "), max, l);
1889 va_end(vargs);
1890 return 0;
1891 }
1892 for (i = 0; i < l; i++) {
1893 o = va_arg(vargs, PyObject **);
1894 *o = PyTuple_GET_ITEM(args, i);
1895 }
1896 va_end(vargs);
1897 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001898}
Georg Brandl02c42872005-08-26 06:42:30 +00001899
1900
1901/* For type constructors that don't take keyword args
1902 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001903 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001904 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001905 */
1906int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001907_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001908{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 if (kw == NULL)
1910 return 1;
1911 if (!PyDict_CheckExact(kw)) {
1912 PyErr_BadInternalCall();
1913 return 0;
1914 }
1915 if (PyDict_Size(kw) == 0)
1916 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001918 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1919 funcname);
1920 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001921}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001922#ifdef __cplusplus
1923};
1924#endif