blob: 0e7d9c43506497622de6af5d009dc8aaba73534e [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
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000108 Py_VA_COPY(lva, va);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000109
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000110 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000111}
112
Martin v. Löwis18e16552006-02-15 17:27:45 +0000113int
114_PyArg_VaParse_SizeT(PyObject *args, char *format, va_list va)
115{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000116 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000117
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000118 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000119
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000120 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000121}
122
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000123
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000124/* Handle cleanup of allocated memory in case of exception */
125
Benjamin Petersonb173f782009-05-05 22:31:58 +0000126#define GETARGS_CAPSULE_NAME_CLEANUP_PTR "getargs.cleanup_ptr"
127#define GETARGS_CAPSULE_NAME_CLEANUP_BUFFER "getargs.cleanup_buffer"
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000128#define GETARGS_CAPSULE_NAME_CLEANUP_CONVERT "getargs.cleanup_convert"
Benjamin Petersonb173f782009-05-05 22:31:58 +0000129
Antoine Pitrouf71995782008-08-29 18:37:05 +0000130static void
Benjamin Petersonb173f782009-05-05 22:31:58 +0000131cleanup_ptr(PyObject *self)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000132{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000133 void *ptr = PyCapsule_GetPointer(self, GETARGS_CAPSULE_NAME_CLEANUP_PTR);
134 if (ptr) {
135 PyMem_FREE(ptr);
136 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000137}
138
139static void
Benjamin Petersonb173f782009-05-05 22:31:58 +0000140cleanup_buffer(PyObject *self)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000141{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000142 Py_buffer *ptr = (Py_buffer *)PyCapsule_GetPointer(self, GETARGS_CAPSULE_NAME_CLEANUP_BUFFER);
143 if (ptr) {
144 PyBuffer_Release(ptr);
145 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000146}
147
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000148static int
Victor Stinnera093d0d2011-01-04 11:16:48 +0000149addcleanup(void *ptr, PyObject **freelist, int is_buffer)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000150{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000151 PyObject *cobj;
152 const char *name;
Victor Stinnera093d0d2011-01-04 11:16:48 +0000153 PyCapsule_Destructor destr;
154
155 if (is_buffer) {
156 destr = cleanup_buffer;
157 name = GETARGS_CAPSULE_NAME_CLEANUP_BUFFER;
158 } else {
159 destr = cleanup_ptr;
160 name = GETARGS_CAPSULE_NAME_CLEANUP_PTR;
161 }
Benjamin Petersonb173f782009-05-05 22:31:58 +0000162
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000163 if (!*freelist) {
164 *freelist = PyList_New(0);
165 if (!*freelist) {
166 destr(ptr);
167 return -1;
168 }
169 }
Benjamin Petersonb173f782009-05-05 22:31:58 +0000170
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000171 cobj = PyCapsule_New(ptr, name, destr);
172 if (!cobj) {
173 destr(ptr);
174 return -1;
175 }
176 if (PyList_Append(*freelist, cobj)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000177 Py_DECREF(cobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000178 return -1;
179 }
180 Py_DECREF(cobj);
181 return 0;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000182}
183
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000184static void
185cleanup_convert(PyObject *self)
186{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000187 typedef int (*destr_t)(PyObject *, void *);
188 destr_t destr = (destr_t)PyCapsule_GetContext(self);
189 void *ptr = PyCapsule_GetPointer(self,
190 GETARGS_CAPSULE_NAME_CLEANUP_CONVERT);
191 if (ptr && destr)
192 destr(NULL, ptr);
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000193}
194
195static int
196addcleanup_convert(void *ptr, PyObject **freelist, int (*destr)(PyObject*,void*))
197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000198 PyObject *cobj;
199 if (!*freelist) {
200 *freelist = PyList_New(0);
201 if (!*freelist) {
202 destr(NULL, ptr);
203 return -1;
204 }
205 }
206 cobj = PyCapsule_New(ptr, GETARGS_CAPSULE_NAME_CLEANUP_CONVERT,
207 cleanup_convert);
208 if (!cobj) {
209 destr(NULL, ptr);
210 return -1;
211 }
212 if (PyCapsule_SetContext(cobj, destr) == -1) {
213 /* This really should not happen. */
214 Py_FatalError("capsule refused setting of context.");
215 }
216 if (PyList_Append(*freelist, cobj)) {
217 Py_DECREF(cobj); /* This will also call destr. */
218 return -1;
219 }
220 Py_DECREF(cobj);
221 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000222}
223
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000224static int
225cleanreturn(int retval, PyObject *freelist)
226{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000227 if (freelist && retval != 0) {
228 /* We were successful, reset the destructors so that they
229 don't get called. */
230 Py_ssize_t len = PyList_GET_SIZE(freelist), i;
231 for (i = 0; i < len; i++)
232 PyCapsule_SetDestructor(PyList_GET_ITEM(freelist, i), NULL);
233 }
234 Py_XDECREF(freelist);
235 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000236}
237
238
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000239static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000240vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000241{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000242 char msgbuf[256];
243 int levels[32];
244 const char *fname = NULL;
245 const char *message = NULL;
246 int min = -1;
247 int max = 0;
248 int level = 0;
249 int endfmt = 0;
250 const char *formatsave = format;
251 Py_ssize_t i, len;
252 char *msg;
253 PyObject *freelist = NULL;
254 int compat = flags & FLAG_COMPAT;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000256 assert(compat || (args != (PyObject*)NULL));
257 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000258
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000259 while (endfmt == 0) {
260 int c = *format++;
261 switch (c) {
262 case '(':
263 if (level == 0)
264 max++;
265 level++;
266 if (level >= 30)
267 Py_FatalError("too many tuple nesting levels "
268 "in argument format string");
269 break;
270 case ')':
271 if (level == 0)
272 Py_FatalError("excess ')' in getargs format");
273 else
274 level--;
275 break;
276 case '\0':
277 endfmt = 1;
278 break;
279 case ':':
280 fname = format;
281 endfmt = 1;
282 break;
283 case ';':
284 message = format;
285 endfmt = 1;
286 break;
287 default:
288 if (level == 0) {
289 if (c == 'O')
290 max++;
291 else if (isalpha(Py_CHARMASK(c))) {
292 if (c != 'e') /* skip encoded */
293 max++;
294 } else if (c == '|')
295 min = max;
296 }
297 break;
298 }
299 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000300
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000301 if (level != 0)
302 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000303
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000304 if (min < 0)
305 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000309 if (compat) {
310 if (max == 0) {
311 if (args == NULL)
312 return 1;
Victor Stinner6ced7c42011-03-21 18:15:42 +0100313 PyErr_Format(PyExc_TypeError,
314 "%.200s%s takes no arguments",
315 fname==NULL ? "function" : fname,
316 fname==NULL ? "" : "()");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000317 return 0;
318 }
319 else if (min == 1 && max == 1) {
320 if (args == NULL) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100321 PyErr_Format(PyExc_TypeError,
322 "%.200s%s takes at least one argument",
323 fname==NULL ? "function" : fname,
324 fname==NULL ? "" : "()");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000325 return 0;
326 }
327 msg = convertitem(args, &format, p_va, flags, levels,
328 msgbuf, sizeof(msgbuf), &freelist);
329 if (msg == NULL)
330 return cleanreturn(1, freelist);
331 seterror(levels[0], msg, levels+1, fname, message);
332 return cleanreturn(0, freelist);
333 }
334 else {
335 PyErr_SetString(PyExc_SystemError,
336 "old style getargs format uses new features");
337 return 0;
338 }
339 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000341 if (!PyTuple_Check(args)) {
342 PyErr_SetString(PyExc_SystemError,
343 "new style getargs format but argument is not a tuple");
344 return 0;
345 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 if (len < min || max < len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100350 if (message == NULL)
351 PyErr_Format(PyExc_TypeError,
352 "%.150s%s takes %s %d argument%s (%ld given)",
353 fname==NULL ? "function" : fname,
354 fname==NULL ? "" : "()",
355 min==max ? "exactly"
356 : len < min ? "at least" : "at most",
357 len < min ? min : max,
358 (len < min ? min : max) == 1 ? "" : "s",
359 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
360 else
361 PyErr_SetString(PyExc_TypeError, message);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000362 return 0;
363 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000365 for (i = 0; i < len; i++) {
366 if (*format == '|')
367 format++;
368 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
369 flags, levels, msgbuf,
370 sizeof(msgbuf), &freelist);
371 if (msg) {
372 seterror(i+1, msg, levels, fname, msg);
373 return cleanreturn(0, freelist);
374 }
375 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000376
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
378 *format != '(' &&
379 *format != '|' && *format != ':' && *format != ';') {
380 PyErr_Format(PyExc_SystemError,
381 "bad format string: %.200s", formatsave);
382 return cleanreturn(0, freelist);
383 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000384
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000385 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000386}
387
388
389
390static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000391seterror(int iarg, const char *msg, int *levels, const char *fname,
392 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000393{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000394 char buf[512];
395 int i;
396 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000397
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000398 if (PyErr_Occurred())
399 return;
400 else if (message == NULL) {
401 if (fname != NULL) {
402 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
403 p += strlen(p);
404 }
405 if (iarg != 0) {
406 PyOS_snprintf(p, sizeof(buf) - (p - buf),
407 "argument %d", iarg);
408 i = 0;
409 p += strlen(p);
410 while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
411 PyOS_snprintf(p, sizeof(buf) - (p - buf),
412 ", item %d", levels[i]-1);
413 p += strlen(p);
414 i++;
415 }
416 }
417 else {
418 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
419 p += strlen(p);
420 }
421 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
422 message = buf;
423 }
424 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000425}
426
427
428/* Convert a tuple argument.
429 On entry, *p_format points to the character _after_ the opening '('.
430 On successful exit, *p_format points to the closing ')'.
431 If successful:
432 *p_format and *p_va are updated,
433 *levels and *msgbuf are untouched,
434 and NULL is returned.
435 If the argument is invalid:
436 *p_format is unchanged,
437 *p_va is undefined,
438 *levels is a 0-terminated list of item numbers,
439 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 "must be <typename1>, not <typename2>", where:
441 <typename1> is the name of the expected type, and
442 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000443 and msgbuf is returned.
444*/
445
446static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000447converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000448 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000449 PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000450{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000451 int level = 0;
452 int n = 0;
453 const char *format = *p_format;
454 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 for (;;) {
457 int c = *format++;
458 if (c == '(') {
459 if (level == 0)
460 n++;
461 level++;
462 }
463 else if (c == ')') {
464 if (level == 0)
465 break;
466 level--;
467 }
468 else if (c == ':' || c == ';' || c == '\0')
469 break;
470 else if (level == 0 && isalpha(Py_CHARMASK(c)))
471 n++;
472 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000474 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
475 levels[0] = 0;
476 PyOS_snprintf(msgbuf, bufsize,
477 toplevel ? "expected %d arguments, not %.50s" :
478 "must be %d-item sequence, not %.50s",
479 n,
480 arg == Py_None ? "None" : arg->ob_type->tp_name);
481 return msgbuf;
482 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000484 if ((i = PySequence_Size(arg)) != n) {
485 levels[0] = 0;
486 PyOS_snprintf(msgbuf, bufsize,
487 toplevel ? "expected %d arguments, not %d" :
488 "must be sequence of length %d, not %d",
489 n, i);
490 return msgbuf;
491 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000493 format = *p_format;
494 for (i = 0; i < n; i++) {
495 char *msg;
496 PyObject *item;
497 item = PySequence_GetItem(arg, i);
498 if (item == NULL) {
499 PyErr_Clear();
500 levels[0] = i+1;
501 levels[1] = 0;
502 strncpy(msgbuf, "is not retrievable", bufsize);
503 return msgbuf;
504 }
505 msg = convertitem(item, &format, p_va, flags, levels+1,
506 msgbuf, bufsize, freelist);
507 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
508 Py_XDECREF(item);
509 if (msg != NULL) {
510 levels[0] = i+1;
511 return msg;
512 }
513 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000514
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000515 *p_format = format;
516 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000517}
518
519
520/* Convert a single item. */
521
522static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000523convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
524 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000525{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000526 char *msg;
527 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000529 if (*format == '(' /* ')' */) {
530 format++;
531 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
532 bufsize, 0, freelist);
533 if (msg == NULL)
534 format++;
535 }
536 else {
537 msg = convertsimple(arg, &format, p_va, flags,
538 msgbuf, bufsize, freelist);
539 if (msg != NULL)
540 levels[0] = 0;
541 }
542 if (msg == NULL)
543 *p_format = format;
544 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000545}
546
547
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000548
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000549/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000550
551static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000552converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000553{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 assert(expected != NULL);
555 assert(arg != NULL);
556 PyOS_snprintf(msgbuf, bufsize,
557 "must be %.50s, not %.50s", expected,
558 arg == Py_None ? "None" : arg->ob_type->tp_name);
559 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000560}
561
562#define CONV_UNICODE "(unicode conversion error)"
563
Guido van Rossum45aecf42006-03-15 04:58:47 +0000564/* Explicitly check for float arguments when integers are expected.
565 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000566static int
567float_argument_error(PyObject *arg)
568{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000569 if (PyFloat_Check(arg)) {
570 PyErr_SetString(PyExc_TypeError,
571 "integer argument expected, got float" );
572 return 1;
573 }
574 else
575 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000576}
577
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000578/* Convert a non-tuple argument. Return NULL if conversion went OK,
579 or a string with a message describing the failure. The message is
580 formatted as "must be <desired type>, not <actual type>".
581 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000582 Don't call if a tuple is expected.
583
584 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000585*/
586
587static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000588convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000589 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000590{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000591 /* For # codes */
592#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
593 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
594 else q=va_arg(*p_va, int*);
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000595#define STORE_SIZE(s) \
596 if (flags & FLAG_SIZE_T) \
597 *q2=s; \
598 else { \
599 if (INT_MAX < s) { \
600 PyErr_SetString(PyExc_OverflowError, \
601 "size does not fit in an int"); \
602 return converterr("", arg, msgbuf, bufsize); \
603 } \
604 *q=s; \
605 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000606#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000607#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000609 const char *format = *p_format;
610 char c = *format++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200611 char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000612
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000613 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000615 case 'b': { /* unsigned byte -- very short int */
616 char *p = va_arg(*p_va, char *);
617 long ival;
618 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000619 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000620 ival = PyLong_AsLong(arg);
621 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000622 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000623 else if (ival < 0) {
624 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000625 "unsigned byte integer is less than minimum");
626 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 }
628 else if (ival > UCHAR_MAX) {
629 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000630 "unsigned byte integer is greater than maximum");
631 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000632 }
633 else
634 *p = (unsigned char) ival;
635 break;
636 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000638 case 'B': {/* byte sized bitfield - both signed and unsigned
639 values allowed */
640 char *p = va_arg(*p_va, char *);
641 long ival;
642 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000643 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000644 ival = PyLong_AsUnsignedLongMask(arg);
645 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000646 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000647 else
648 *p = (unsigned char) ival;
649 break;
650 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000651
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000652 case 'h': {/* signed short int */
653 short *p = va_arg(*p_va, short *);
654 long ival;
655 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000656 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000657 ival = PyLong_AsLong(arg);
658 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000659 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000660 else if (ival < SHRT_MIN) {
661 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000662 "signed short integer is less than minimum");
663 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000664 }
665 else if (ival > SHRT_MAX) {
666 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000667 "signed short integer is greater than maximum");
668 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000669 }
670 else
671 *p = (short) ival;
672 break;
673 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 case 'H': { /* short int sized bitfield, both signed and
676 unsigned allowed */
677 unsigned short *p = va_arg(*p_va, unsigned short *);
678 long ival;
679 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000680 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000681 ival = PyLong_AsUnsignedLongMask(arg);
682 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000683 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000684 else
685 *p = (unsigned short) ival;
686 break;
687 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000689 case 'i': {/* signed int */
690 int *p = va_arg(*p_va, int *);
691 long ival;
692 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000693 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000694 ival = PyLong_AsLong(arg);
695 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000696 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 else if (ival > INT_MAX) {
698 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000699 "signed integer is greater than maximum");
700 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 }
702 else if (ival < INT_MIN) {
703 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000704 "signed integer is less than minimum");
705 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000706 }
707 else
708 *p = ival;
709 break;
710 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000711
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000712 case 'I': { /* int sized bitfield, both signed and
713 unsigned allowed */
714 unsigned int *p = va_arg(*p_va, unsigned int *);
715 unsigned int ival;
716 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000717 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
719 if (ival == (unsigned int)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000720 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000721 else
722 *p = ival;
723 break;
724 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000725
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 case 'n': /* Py_ssize_t */
727 {
728 PyObject *iobj;
729 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
730 Py_ssize_t ival = -1;
731 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000732 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000733 iobj = PyNumber_Index(arg);
734 if (iobj != NULL) {
735 ival = PyLong_AsSsize_t(iobj);
736 Py_DECREF(iobj);
737 }
738 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000739 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 *p = ival;
741 break;
742 }
743 case 'l': {/* long int */
744 long *p = va_arg(*p_va, long *);
745 long ival;
746 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000747 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000748 ival = PyLong_AsLong(arg);
749 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000750 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000751 else
752 *p = ival;
753 break;
754 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000755
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000756 case 'k': { /* long sized bitfield */
757 unsigned long *p = va_arg(*p_va, unsigned long *);
758 unsigned long ival;
759 if (PyLong_Check(arg))
760 ival = PyLong_AsUnsignedLongMask(arg);
761 else
762 return converterr("integer<k>", arg, msgbuf, bufsize);
763 *p = ival;
764 break;
765 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000766
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000767#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000768 case 'L': {/* PY_LONG_LONG */
769 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
770 PY_LONG_LONG ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000771 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000772 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000773 ival = PyLong_AsLongLong(arg);
Mark Dickinsonc7301312010-06-10 16:05:10 +0000774 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000775 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000776 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000777 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 break;
779 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000780
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 case 'K': { /* long long sized bitfield */
782 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
783 unsigned PY_LONG_LONG ival;
784 if (PyLong_Check(arg))
785 ival = PyLong_AsUnsignedLongLongMask(arg);
786 else
787 return converterr("integer<K>", arg, msgbuf, bufsize);
788 *p = ival;
789 break;
790 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000791#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000792
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 case 'f': {/* float */
794 float *p = va_arg(*p_va, float *);
795 double dval = PyFloat_AsDouble(arg);
796 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000797 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000798 else
799 *p = (float) dval;
800 break;
801 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 case 'd': {/* double */
804 double *p = va_arg(*p_va, double *);
805 double dval = PyFloat_AsDouble(arg);
806 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000807 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 else
809 *p = dval;
810 break;
811 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000812
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 case 'D': {/* complex double */
814 Py_complex *p = va_arg(*p_va, Py_complex *);
815 Py_complex cval;
816 cval = PyComplex_AsCComplex(arg);
817 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000818 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 else
820 *p = cval;
821 break;
822 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000823
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 case 'c': {/* char */
825 char *p = va_arg(*p_va, char *);
826 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
827 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300828 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
829 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 else
831 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
832 break;
833 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000834
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000835 case 'C': {/* unicode char */
836 int *p = va_arg(*p_va, int *);
837 if (PyUnicode_Check(arg) &&
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200838 PyUnicode_GET_LENGTH(arg) == 1) {
839 int kind = PyUnicode_KIND(arg);
840 void *data = PyUnicode_DATA(arg);
841 *p = PyUnicode_READ(kind, data, 0);
842 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 else
844 return converterr("a unicode character", arg, msgbuf, bufsize);
845 break;
846 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000847
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000848 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000849 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000850
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000851 case 'y': {/* any buffer-like object, but not PyUnicode */
852 void **p = (void **)va_arg(*p_va, char **);
853 char *buf;
854 Py_ssize_t count;
855 if (*format == '*') {
856 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
857 return converterr(buf, arg, msgbuf, bufsize);
858 format++;
Victor Stinnera093d0d2011-01-04 11:16:48 +0000859 if (addcleanup(p, freelist, 1)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000860 return converterr(
861 "(cleanup problem)",
862 arg, msgbuf, bufsize);
863 }
864 break;
865 }
866 count = convertbuffer(arg, p, &buf);
867 if (count < 0)
868 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000869 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 FETCH_SIZE;
871 STORE_SIZE(count);
872 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000873 } else {
874 if (strlen(*p) != count)
875 return converterr(
876 "bytes without null bytes",
877 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000878 }
879 break;
880 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000881
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000882 case 's': /* text string */
883 case 'z': /* text string or None */
884 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000885 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000886 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000887 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000888
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000889 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000890 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
891 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200892 Py_ssize_t len;
893 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
894 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000895 return converterr(CONV_UNICODE,
896 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200897 PyBuffer_FillInfo(p, arg, sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000898 }
899 else { /* any buffer-like object */
900 char *buf;
901 if (getbuffer(arg, p, &buf) < 0)
902 return converterr(buf, arg, msgbuf, bufsize);
903 }
Victor Stinnera093d0d2011-01-04 11:16:48 +0000904 if (addcleanup(p, freelist, 1)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 return converterr(
906 "(cleanup problem)",
907 arg, msgbuf, bufsize);
908 }
909 format++;
910 } else if (*format == '#') { /* any buffer-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000911 /* "s#" or "z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000912 void **p = (void **)va_arg(*p_va, char **);
913 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000914
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000915 if (c == 'z' && arg == Py_None) {
916 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000917 STORE_SIZE(0);
918 }
919 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200920 Py_ssize_t len;
921 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
922 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000923 return converterr(CONV_UNICODE,
924 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200925 *p = sarg;
926 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 }
928 else { /* any buffer-like object */
929 /* XXX Really? */
930 char *buf;
931 Py_ssize_t count = convertbuffer(arg, p, &buf);
932 if (count < 0)
933 return converterr(buf, arg, msgbuf, bufsize);
934 STORE_SIZE(count);
935 }
936 format++;
937 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000938 /* "s" or "z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000939 char **p = va_arg(*p_va, char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200940 Py_ssize_t len;
941 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000942
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000943 if (c == 'z' && arg == Py_None)
944 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000945 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200946 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
947 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000948 return converterr(CONV_UNICODE,
949 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200950 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 }
952 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000953 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000954 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200955 if (*p != NULL && sarg != NULL && (Py_ssize_t) strlen(*p) != len)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 return converterr(
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000957 c == 'z' ? "str without null bytes or None"
958 : "str without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000959 arg, msgbuf, bufsize);
960 }
961 break;
962 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000963
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000964 case 'u': /* raw unicode buffer (Py_UNICODE *) */
965 case 'Z': /* raw unicode buffer or None */
966 {
Brett Cannonb94767f2011-02-22 20:15:44 +0000967 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
968
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000969 if (*format == '#') { /* any buffer-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000970 /* "s#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000972
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000973 if (c == 'Z' && arg == Py_None) {
974 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000975 STORE_SIZE(0);
976 }
977 else if (PyUnicode_Check(arg)) {
978 *p = PyUnicode_AS_UNICODE(arg);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200979 if (*p == NULL)
980 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 STORE_SIZE(PyUnicode_GET_SIZE(arg));
982 }
Victor Stinner5216e6d2010-06-08 21:45:51 +0000983 else
984 return converterr("str or None", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000985 format++;
986 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000987 /* "s" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000988 if (c == 'Z' && arg == Py_None)
989 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000990 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000991 *p = PyUnicode_AS_UNICODE(arg);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200992 if (*p == NULL)
993 RETURN_ERR_OCCURRED;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000994 if (Py_UNICODE_strlen(*p) != PyUnicode_GET_SIZE(arg))
995 return converterr(
996 "str without null character or None",
997 arg, msgbuf, bufsize);
998 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000999 return converterr(c == 'Z' ? "str or None" : "str",
1000 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001001 }
1002 break;
1003 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001004
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001005 case 'e': {/* encoded string */
1006 char **buffer;
1007 const char *encoding;
1008 PyObject *s;
1009 int recode_strings;
1010 Py_ssize_t size;
1011 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001012
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001013 /* Get 'e' parameter: the encoding name */
1014 encoding = (const char *)va_arg(*p_va, const char *);
1015 if (encoding == NULL)
1016 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001017
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001018 /* Get output buffer parameter:
1019 's' (recode all objects via Unicode) or
1020 't' (only recode non-string objects)
1021 */
1022 if (*format == 's')
1023 recode_strings = 1;
1024 else if (*format == 't')
1025 recode_strings = 0;
1026 else
1027 return converterr(
1028 "(unknown parser marker combination)",
1029 arg, msgbuf, bufsize);
1030 buffer = (char **)va_arg(*p_va, char **);
1031 format++;
1032 if (buffer == NULL)
1033 return converterr("(buffer is NULL)",
1034 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001035
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 /* Encode object */
1037 if (!recode_strings &&
1038 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1039 s = arg;
1040 Py_INCREF(s);
1041 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1042 return converterr("(AsCharBuffer failed)",
1043 arg, msgbuf, bufsize);
1044 }
1045 else {
1046 PyObject *u;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001047
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001048 /* Convert object to Unicode */
1049 u = PyUnicode_FromObject(arg);
1050 if (u == NULL)
1051 return converterr(
1052 "string or unicode or text buffer",
1053 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001054
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 /* Encode object; use default error handling */
1056 s = PyUnicode_AsEncodedString(u,
1057 encoding,
1058 NULL);
1059 Py_DECREF(u);
1060 if (s == NULL)
1061 return converterr("(encoding failed)",
1062 arg, msgbuf, bufsize);
1063 if (!PyBytes_Check(s)) {
1064 Py_DECREF(s);
1065 return converterr(
1066 "(encoder failed to return bytes)",
1067 arg, msgbuf, bufsize);
1068 }
1069 size = PyBytes_GET_SIZE(s);
1070 ptr = PyBytes_AS_STRING(s);
1071 if (ptr == NULL)
1072 ptr = "";
1073 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001074
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001075 /* Write output; output is guaranteed to be 0-terminated */
1076 if (*format == '#') {
1077 /* Using buffer length parameter '#':
1078
1079 - if *buffer is NULL, a new buffer of the
1080 needed size is allocated and the data
1081 copied into it; *buffer is updated to point
1082 to the new buffer; the caller is
1083 responsible for PyMem_Free()ing it after
1084 usage
1085
1086 - if *buffer is not NULL, the data is
1087 copied to *buffer; *buffer_len has to be
1088 set to the size of the buffer on input;
1089 buffer overflow is signalled with an error;
1090 buffer has to provide enough room for the
1091 encoded string plus the trailing 0-byte
1092
1093 - in both cases, *buffer_len is updated to
1094 the size of the buffer /excluding/ the
1095 trailing 0-byte
1096
1097 */
1098 FETCH_SIZE;
1099
1100 format++;
1101 if (q == NULL && q2 == NULL) {
1102 Py_DECREF(s);
1103 return converterr(
1104 "(buffer_len is NULL)",
1105 arg, msgbuf, bufsize);
1106 }
1107 if (*buffer == NULL) {
1108 *buffer = PyMem_NEW(char, size + 1);
1109 if (*buffer == NULL) {
1110 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001111 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001112 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001113 }
Victor Stinnera093d0d2011-01-04 11:16:48 +00001114 if (addcleanup(*buffer, freelist, 0)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 Py_DECREF(s);
1116 return converterr(
1117 "(cleanup problem)",
1118 arg, msgbuf, bufsize);
1119 }
1120 } else {
1121 if (size + 1 > BUFFER_LEN) {
1122 Py_DECREF(s);
1123 return converterr(
1124 "(buffer overflow)",
1125 arg, msgbuf, bufsize);
1126 }
1127 }
1128 memcpy(*buffer, ptr, size+1);
1129 STORE_SIZE(size);
1130 } else {
1131 /* Using a 0-terminated buffer:
1132
1133 - the encoded string has to be 0-terminated
1134 for this variant to work; if it is not, an
1135 error raised
1136
1137 - a new buffer of the needed size is
1138 allocated and the data copied into it;
1139 *buffer is updated to point to the new
1140 buffer; the caller is responsible for
1141 PyMem_Free()ing it after usage
1142
1143 */
1144 if ((Py_ssize_t)strlen(ptr) != size) {
1145 Py_DECREF(s);
1146 return converterr(
1147 "encoded string without NULL bytes",
1148 arg, msgbuf, bufsize);
1149 }
1150 *buffer = PyMem_NEW(char, size + 1);
1151 if (*buffer == NULL) {
1152 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001153 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001154 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001155 }
Victor Stinnera093d0d2011-01-04 11:16:48 +00001156 if (addcleanup(*buffer, freelist, 0)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001157 Py_DECREF(s);
1158 return converterr("(cleanup problem)",
1159 arg, msgbuf, bufsize);
1160 }
1161 memcpy(*buffer, ptr, size+1);
1162 }
1163 Py_DECREF(s);
1164 break;
1165 }
1166
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001167 case 'S': { /* PyBytes object */
1168 PyObject **p = va_arg(*p_va, PyObject **);
1169 if (PyBytes_Check(arg))
1170 *p = arg;
1171 else
1172 return converterr("bytes", arg, msgbuf, bufsize);
1173 break;
1174 }
1175
1176 case 'Y': { /* PyByteArray object */
1177 PyObject **p = va_arg(*p_va, PyObject **);
1178 if (PyByteArray_Check(arg))
1179 *p = arg;
1180 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001181 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001182 break;
1183 }
1184
1185 case 'U': { /* PyUnicode object */
1186 PyObject **p = va_arg(*p_va, PyObject **);
1187 if (PyUnicode_Check(arg))
1188 *p = arg;
1189 else
1190 return converterr("str", arg, msgbuf, bufsize);
1191 break;
1192 }
1193
1194 case 'O': { /* object */
1195 PyTypeObject *type;
1196 PyObject **p;
1197 if (*format == '!') {
1198 type = va_arg(*p_va, PyTypeObject*);
1199 p = va_arg(*p_va, PyObject **);
1200 format++;
1201 if (PyType_IsSubtype(arg->ob_type, type))
1202 *p = arg;
1203 else
1204 return converterr(type->tp_name, arg, msgbuf, bufsize);
1205
1206 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001207 else if (*format == '&') {
1208 typedef int (*converter)(PyObject *, void *);
1209 converter convert = va_arg(*p_va, converter);
1210 void *addr = va_arg(*p_va, void *);
1211 int res;
1212 format++;
1213 if (! (res = (*convert)(arg, addr)))
1214 return converterr("(unspecified)",
1215 arg, msgbuf, bufsize);
1216 if (res == Py_CLEANUP_SUPPORTED &&
1217 addcleanup_convert(addr, freelist, convert) == -1)
1218 return converterr("(cleanup problem)",
1219 arg, msgbuf, bufsize);
1220 }
1221 else {
1222 p = va_arg(*p_va, PyObject **);
1223 *p = arg;
1224 }
1225 break;
1226 }
1227
1228
Victor Stinner25e8ec42010-06-25 00:02:38 +00001229 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001230 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001231
Victor Stinner25e8ec42010-06-25 00:02:38 +00001232 if (*format != '*')
1233 return converterr(
1234 "invalid use of 'w' format character",
1235 arg, msgbuf, bufsize);
1236 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237
Victor Stinner25e8ec42010-06-25 00:02:38 +00001238 /* Caller is interested in Py_buffer, and the object
1239 supports it directly. */
1240 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1241 PyErr_Clear();
1242 return converterr("read-write buffer", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 }
Victor Stinner8182b712010-07-28 00:40:58 +00001244 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1245 PyBuffer_Release((Py_buffer*)p);
1246 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1247 }
Victor Stinnera093d0d2011-01-04 11:16:48 +00001248 if (addcleanup(p, freelist, 1)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001249 return converterr(
1250 "(cleanup problem)",
1251 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001252 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 break;
1254 }
1255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001256 default:
1257 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
1258
1259 }
1260
1261 *p_format = format;
1262 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001263
1264#undef FETCH_SIZE
1265#undef STORE_SIZE
1266#undef BUFFER_LEN
1267#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001268}
Guido van Rossumaa354651996-08-19 19:32:04 +00001269
Martin v. Löwis18e16552006-02-15 17:27:45 +00001270static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001271convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001272{
Victor Stinner5cb62392010-06-06 20:27:51 +00001273 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001274 Py_ssize_t count;
1275 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001277 *errmsg = NULL;
1278 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001279 if (pb != NULL && pb->bf_releasebuffer != NULL) {
1280 *errmsg = "read-only pinned buffer";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001281 return -1;
1282 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001283
Victor Stinner8182b712010-07-28 00:40:58 +00001284 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001285 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001286 count = view.len;
1287 *p = view.buf;
1288 PyBuffer_Release(&view);
1289 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001290}
Guido van Rossumaa354651996-08-19 19:32:04 +00001291
Martin v. Löwis423be952008-08-13 15:53:07 +00001292static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001293getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001294{
Victor Stinner8182b712010-07-28 00:40:58 +00001295 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001296 *errmsg = "bytes or buffer";
1297 return -1;
1298 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001299 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001300 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001301 *errmsg = "contiguous buffer";
1302 return -1;
1303 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001305}
1306
Guido van Rossumaa354651996-08-19 19:32:04 +00001307/* Support for keyword arguments donated by
1308 Geoff Philbrick <philbric@delphi.hks.com> */
1309
Tim Petersf8cd3e82001-10-27 04:26:57 +00001310/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001311int
1312PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001313 PyObject *keywords,
1314 const char *format,
1315 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001316{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001317 int retval;
1318 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001319
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001320 if ((args == NULL || !PyTuple_Check(args)) ||
1321 (keywords != NULL && !PyDict_Check(keywords)) ||
1322 format == NULL ||
1323 kwlist == NULL)
1324 {
1325 PyErr_BadInternalCall();
1326 return 0;
1327 }
Tim Peters45772cd2001-10-27 03:58:40 +00001328
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 va_start(va, kwlist);
1330 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1331 va_end(va);
1332 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001333}
1334
1335int
1336_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 PyObject *keywords,
1338 const char *format,
1339 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001340{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001341 int retval;
1342 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001343
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 if ((args == NULL || !PyTuple_Check(args)) ||
1345 (keywords != NULL && !PyDict_Check(keywords)) ||
1346 format == NULL ||
1347 kwlist == NULL)
1348 {
1349 PyErr_BadInternalCall();
1350 return 0;
1351 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 va_start(va, kwlist);
1354 retval = vgetargskeywords(args, keywords, format,
1355 kwlist, &va, FLAG_SIZE_T);
1356 va_end(va);
1357 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001358}
1359
1360
Brett Cannon711e7d92004-07-10 22:20:32 +00001361int
1362PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001363 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001364 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001365 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001366{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001367 int retval;
1368 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001369
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001370 if ((args == NULL || !PyTuple_Check(args)) ||
1371 (keywords != NULL && !PyDict_Check(keywords)) ||
1372 format == NULL ||
1373 kwlist == NULL)
1374 {
1375 PyErr_BadInternalCall();
1376 return 0;
1377 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001378
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001379 Py_VA_COPY(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001380
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1382 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001383}
1384
1385int
1386_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 PyObject *keywords,
1388 const char *format,
1389 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001390{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 int retval;
1392 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001393
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001394 if ((args == NULL || !PyTuple_Check(args)) ||
1395 (keywords != NULL && !PyDict_Check(keywords)) ||
1396 format == NULL ||
1397 kwlist == NULL)
1398 {
1399 PyErr_BadInternalCall();
1400 return 0;
1401 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001402
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001403 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001405 retval = vgetargskeywords(args, keywords, format,
1406 kwlist, &lva, FLAG_SIZE_T);
1407 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001408}
1409
Benjamin Petersonfb886362010-04-24 18:21:17 +00001410int
1411PyArg_ValidateKeywordArguments(PyObject *kwargs)
1412{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001413 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 PyErr_BadInternalCall();
1415 return 0;
1416 }
1417 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1418 PyErr_SetString(PyExc_TypeError,
1419 "keyword arguments must be strings");
1420 return 0;
1421 }
1422 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001423}
1424
Christian Heimes380f7f22008-02-28 11:19:05 +00001425#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001426
Guido van Rossumaa354651996-08-19 19:32:04 +00001427static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001428vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001429 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001430{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001431 char msgbuf[512];
1432 int levels[32];
1433 const char *fname, *msg, *custom_msg, *keyword;
1434 int min = INT_MAX;
1435 int i, len, nargs, nkeywords;
1436 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001438 assert(args != NULL && PyTuple_Check(args));
1439 assert(keywords == NULL || PyDict_Check(keywords));
1440 assert(format != NULL);
1441 assert(kwlist != NULL);
1442 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 /* grab the function name or custom error msg first (mutually exclusive) */
1445 fname = strchr(format, ':');
1446 if (fname) {
1447 fname++;
1448 custom_msg = NULL;
1449 }
1450 else {
1451 custom_msg = strchr(format,';');
1452 if (custom_msg)
1453 custom_msg++;
1454 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 /* scan kwlist and get greatest possible nbr of args */
1457 for (len=0; kwlist[len]; len++)
1458 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 nargs = PyTuple_GET_SIZE(args);
1461 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1462 if (nargs + nkeywords > len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +01001463 PyErr_Format(PyExc_TypeError,
1464 "%s%s takes at most %d argument%s (%d given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001465 (fname == NULL) ? "function" : fname,
1466 (fname == NULL) ? "" : "()",
1467 len,
1468 (len == 1) ? "" : "s",
1469 nargs + nkeywords);
1470 return 0;
1471 }
Tim Petersc2f01122001-10-27 07:25:06 +00001472
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001473 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1474 for (i = 0; i < len; i++) {
1475 keyword = kwlist[i];
1476 if (*format == '|') {
1477 min = i;
1478 format++;
1479 }
1480 if (IS_END_OF_FORMAT(*format)) {
1481 PyErr_Format(PyExc_RuntimeError,
1482 "More keyword list entries (%d) than "
1483 "format specifiers (%d)", len, i);
1484 return cleanreturn(0, freelist);
1485 }
1486 current_arg = NULL;
1487 if (nkeywords) {
1488 current_arg = PyDict_GetItemString(keywords, keyword);
1489 }
1490 if (current_arg) {
1491 --nkeywords;
1492 if (i < nargs) {
1493 /* arg present in tuple and in dict */
1494 PyErr_Format(PyExc_TypeError,
1495 "Argument given by name ('%s') "
1496 "and position (%d)",
1497 keyword, i+1);
1498 return cleanreturn(0, freelist);
1499 }
1500 }
1501 else if (nkeywords && PyErr_Occurred())
1502 return cleanreturn(0, freelist);
1503 else if (i < nargs)
1504 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimes380f7f22008-02-28 11:19:05 +00001505
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 if (current_arg) {
1507 msg = convertitem(current_arg, &format, p_va, flags,
1508 levels, msgbuf, sizeof(msgbuf), &freelist);
1509 if (msg) {
1510 seterror(i+1, msg, levels, fname, custom_msg);
1511 return cleanreturn(0, freelist);
1512 }
1513 continue;
1514 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001516 if (i < min) {
1517 PyErr_Format(PyExc_TypeError, "Required argument "
1518 "'%s' (pos %d) not found",
1519 keyword, i+1);
1520 return cleanreturn(0, freelist);
1521 }
1522 /* current code reports success when all required args
1523 * fulfilled and no keyword args left, with no further
1524 * validation. XXX Maybe skip this in debug build ?
1525 */
1526 if (!nkeywords)
1527 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 /* We are into optional args, skip thru to any remaining
1530 * keyword args */
1531 msg = skipitem(&format, p_va, flags);
1532 if (msg) {
1533 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1534 format);
1535 return cleanreturn(0, freelist);
1536 }
1537 }
Tim Petersb054be42001-10-27 05:07:41 +00001538
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001539 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
1540 PyErr_Format(PyExc_RuntimeError,
1541 "more argument specifiers than keyword list entries "
1542 "(remaining format:'%s')", format);
1543 return cleanreturn(0, freelist);
1544 }
Tim Petersc2f01122001-10-27 07:25:06 +00001545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001546 /* make sure there are no extraneous keyword arguments */
1547 if (nkeywords > 0) {
1548 PyObject *key, *value;
1549 Py_ssize_t pos = 0;
1550 while (PyDict_Next(keywords, &pos, &key, &value)) {
1551 int match = 0;
1552 char *ks;
1553 if (!PyUnicode_Check(key)) {
1554 PyErr_SetString(PyExc_TypeError,
1555 "keywords must be strings");
1556 return cleanreturn(0, freelist);
1557 }
Victor Stinner93b55132010-05-19 00:54:06 +00001558 /* check that _PyUnicode_AsString() result is not NULL */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 ks = _PyUnicode_AsString(key);
Victor Stinner93b55132010-05-19 00:54:06 +00001560 if (ks != NULL) {
1561 for (i = 0; i < len; i++) {
1562 if (!strcmp(ks, kwlist[i])) {
1563 match = 1;
1564 break;
1565 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001566 }
1567 }
1568 if (!match) {
1569 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001570 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001572 key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001573 return cleanreturn(0, freelist);
1574 }
1575 }
1576 }
1577
1578 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001579}
1580
1581
1582static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001583skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001584{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 const char *format = *p_format;
1586 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001587
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 /* simple codes
1591 * The individual types (second arg of va_arg) are irrelevant */
Georg Brandl6dd14612005-09-14 19:29:53 +00001592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001593 case 'b': /* byte -- very short int */
1594 case 'B': /* byte as bitfield */
1595 case 'h': /* short int */
1596 case 'H': /* short int as bitfield */
1597 case 'i': /* int */
1598 case 'I': /* int sized bitfield */
1599 case 'l': /* long int */
1600 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001601#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 case 'L': /* PY_LONG_LONG */
1603 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001604#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001605 case 'f': /* float */
1606 case 'd': /* double */
1607 case 'D': /* complex double */
1608 case 'c': /* char */
1609 case 'C': /* unicode char */
1610 {
1611 (void) va_arg(*p_va, void *);
1612 break;
1613 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 case 'n': /* Py_ssize_t */
1616 {
1617 (void) va_arg(*p_va, Py_ssize_t *);
1618 break;
1619 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001620
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001622
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 case 'e': /* string with encoding */
1624 {
1625 (void) va_arg(*p_va, const char *);
1626 if (!(*format == 's' || *format == 't'))
1627 /* after 'e', only 's' and 't' is allowed */
1628 goto err;
1629 format++;
1630 /* explicit fallthrough to string cases */
1631 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001632
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 case 's': /* string */
1634 case 'z': /* string or None */
1635 case 'y': /* bytes */
1636 case 'u': /* unicode string */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 case 'w': /* buffer, read-write */
1638 {
1639 (void) va_arg(*p_va, char **);
1640 if (*format == '#') {
1641 if (flags & FLAG_SIZE_T)
1642 (void) va_arg(*p_va, Py_ssize_t *);
1643 else
1644 (void) va_arg(*p_va, int *);
1645 format++;
1646 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1647 format++;
1648 }
1649 break;
1650 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001651
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001652 /* object codes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001653
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001654 case 'S': /* string object */
1655 case 'Y': /* string object */
1656 case 'U': /* unicode string object */
1657 {
1658 (void) va_arg(*p_va, PyObject **);
1659 break;
1660 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 case 'O': /* object */
1663 {
1664 if (*format == '!') {
1665 format++;
1666 (void) va_arg(*p_va, PyTypeObject*);
1667 (void) va_arg(*p_va, PyObject **);
1668 }
1669 else if (*format == '&') {
1670 typedef int (*converter)(PyObject *, void *);
1671 (void) va_arg(*p_va, converter);
1672 (void) va_arg(*p_va, void *);
1673 format++;
1674 }
1675 else {
1676 (void) va_arg(*p_va, PyObject **);
1677 }
1678 break;
1679 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001680
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001681 case '(': /* bypass tuple, not handled at all previously */
1682 {
1683 char *msg;
1684 for (;;) {
1685 if (*format==')')
1686 break;
1687 if (IS_END_OF_FORMAT(*format))
1688 return "Unmatched left paren in format "
1689 "string";
1690 msg = skipitem(&format, p_va, flags);
1691 if (msg)
1692 return msg;
1693 }
1694 format++;
1695 break;
1696 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001697
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001698 case ')':
1699 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00001700
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001701 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001702err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001703 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001704
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001706
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001707 *p_format = format;
1708 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001709}
Fred Drakee4616e62001-10-23 21:09:29 +00001710
1711
1712int
Martin v. Löwis76246742006-03-01 04:06:10 +00001713PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001714{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001715 Py_ssize_t i, l;
1716 PyObject **o;
1717 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001718
1719#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001720 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001721#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001722 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001723#endif
1724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001725 assert(min >= 0);
1726 assert(min <= max);
1727 if (!PyTuple_Check(args)) {
1728 PyErr_SetString(PyExc_SystemError,
1729 "PyArg_UnpackTuple() argument list is not a tuple");
1730 return 0;
1731 }
1732 l = PyTuple_GET_SIZE(args);
1733 if (l < min) {
1734 if (name != NULL)
1735 PyErr_Format(
1736 PyExc_TypeError,
1737 "%s expected %s%zd arguments, got %zd",
1738 name, (min == max ? "" : "at least "), min, l);
1739 else
1740 PyErr_Format(
1741 PyExc_TypeError,
1742 "unpacked tuple should have %s%zd elements,"
1743 " but has %zd",
1744 (min == max ? "" : "at least "), min, l);
1745 va_end(vargs);
1746 return 0;
1747 }
1748 if (l > max) {
1749 if (name != NULL)
1750 PyErr_Format(
1751 PyExc_TypeError,
1752 "%s expected %s%zd arguments, got %zd",
1753 name, (min == max ? "" : "at most "), max, l);
1754 else
1755 PyErr_Format(
1756 PyExc_TypeError,
1757 "unpacked tuple should have %s%zd elements,"
1758 " but has %zd",
1759 (min == max ? "" : "at most "), max, l);
1760 va_end(vargs);
1761 return 0;
1762 }
1763 for (i = 0; i < l; i++) {
1764 o = va_arg(vargs, PyObject **);
1765 *o = PyTuple_GET_ITEM(args, i);
1766 }
1767 va_end(vargs);
1768 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001769}
Georg Brandl02c42872005-08-26 06:42:30 +00001770
1771
1772/* For type constructors that don't take keyword args
1773 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001774 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001775 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001776 */
1777int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001778_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001779{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001780 if (kw == NULL)
1781 return 1;
1782 if (!PyDict_CheckExact(kw)) {
1783 PyErr_BadInternalCall();
1784 return 0;
1785 }
1786 if (PyDict_Size(kw) == 0)
1787 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001788
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001789 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1790 funcname);
1791 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001792}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001793#ifdef __cplusplus
1794};
1795#endif