blob: f2cc9f45090ff9abec0f8aa3aa5e2500b6fd62e7 [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 *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200837 int kind;
838 void *data;
839
840 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000841 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200842
843 if (PyUnicode_READY(arg))
844 RETURN_ERR_OCCURRED;
845
846 if (PyUnicode_GET_LENGTH(arg) != 1)
847 return converterr("a unicode character", arg, msgbuf, bufsize);
848
849 kind = PyUnicode_KIND(arg);
850 data = PyUnicode_DATA(arg);
851 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 break;
853 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000854
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000855 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000857
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 case 'y': {/* any buffer-like object, but not PyUnicode */
859 void **p = (void **)va_arg(*p_va, char **);
860 char *buf;
861 Py_ssize_t count;
862 if (*format == '*') {
863 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
864 return converterr(buf, arg, msgbuf, bufsize);
865 format++;
Victor Stinnera093d0d2011-01-04 11:16:48 +0000866 if (addcleanup(p, freelist, 1)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 return converterr(
868 "(cleanup problem)",
869 arg, msgbuf, bufsize);
870 }
871 break;
872 }
873 count = convertbuffer(arg, p, &buf);
874 if (count < 0)
875 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000876 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000877 FETCH_SIZE;
878 STORE_SIZE(count);
879 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000880 } else {
881 if (strlen(*p) != count)
882 return converterr(
883 "bytes without null bytes",
884 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000885 }
886 break;
887 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000888
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000889 case 's': /* text string */
890 case 'z': /* text string or None */
891 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000892 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000893 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000894 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000895
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000896 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000897 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
898 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200899 Py_ssize_t len;
900 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
901 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000902 return converterr(CONV_UNICODE,
903 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200904 PyBuffer_FillInfo(p, arg, sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 }
906 else { /* any buffer-like object */
907 char *buf;
908 if (getbuffer(arg, p, &buf) < 0)
909 return converterr(buf, arg, msgbuf, bufsize);
910 }
Victor Stinnera093d0d2011-01-04 11:16:48 +0000911 if (addcleanup(p, freelist, 1)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000912 return converterr(
913 "(cleanup problem)",
914 arg, msgbuf, bufsize);
915 }
916 format++;
917 } else if (*format == '#') { /* any buffer-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000918 /* "s#" or "z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 void **p = (void **)va_arg(*p_va, char **);
920 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000921
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000922 if (c == 'z' && arg == Py_None) {
923 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000924 STORE_SIZE(0);
925 }
926 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200927 Py_ssize_t len;
928 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
929 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 return converterr(CONV_UNICODE,
931 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200932 *p = sarg;
933 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 }
935 else { /* any buffer-like object */
936 /* XXX Really? */
937 char *buf;
938 Py_ssize_t count = convertbuffer(arg, p, &buf);
939 if (count < 0)
940 return converterr(buf, arg, msgbuf, bufsize);
941 STORE_SIZE(count);
942 }
943 format++;
944 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000945 /* "s" or "z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000946 char **p = va_arg(*p_va, char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200947 Py_ssize_t len;
948 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000949
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000950 if (c == 'z' && arg == Py_None)
951 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000952 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200953 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
954 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 return converterr(CONV_UNICODE,
956 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200957 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 }
959 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000960 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200962 if (*p != NULL && sarg != NULL && (Py_ssize_t) strlen(*p) != len)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000963 return converterr(
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000964 c == 'z' ? "str without null bytes or None"
965 : "str without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000966 arg, msgbuf, bufsize);
967 }
968 break;
969 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000970
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000971 case 'u': /* raw unicode buffer (Py_UNICODE *) */
972 case 'Z': /* raw unicode buffer or None */
973 {
Brett Cannonb94767f2011-02-22 20:15:44 +0000974 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 if (*format == '#') { /* any buffer-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000977 /* "s#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000979
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000980 if (c == 'Z' && arg == Py_None) {
981 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 STORE_SIZE(0);
983 }
984 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200985 Py_ssize_t len;
986 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200987 if (*p == NULL)
988 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200989 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000990 }
Victor Stinner5216e6d2010-06-08 21:45:51 +0000991 else
992 return converterr("str or None", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000993 format++;
994 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000995 /* "s" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000996 if (c == 'Z' && arg == Py_None)
997 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000998 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200999 Py_ssize_t len;
1000 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001001 if (*p == NULL)
1002 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001003 if (Py_UNICODE_strlen(*p) != len)
Victor Stinner06e49dd2010-06-13 18:21:50 +00001004 return converterr(
1005 "str without null character or None",
1006 arg, msgbuf, bufsize);
1007 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001008 return converterr(c == 'Z' ? "str or None" : "str",
1009 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 }
1011 break;
1012 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001013
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 case 'e': {/* encoded string */
1015 char **buffer;
1016 const char *encoding;
1017 PyObject *s;
1018 int recode_strings;
1019 Py_ssize_t size;
1020 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001021
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001022 /* Get 'e' parameter: the encoding name */
1023 encoding = (const char *)va_arg(*p_va, const char *);
1024 if (encoding == NULL)
1025 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 /* Get output buffer parameter:
1028 's' (recode all objects via Unicode) or
1029 't' (only recode non-string objects)
1030 */
1031 if (*format == 's')
1032 recode_strings = 1;
1033 else if (*format == 't')
1034 recode_strings = 0;
1035 else
1036 return converterr(
1037 "(unknown parser marker combination)",
1038 arg, msgbuf, bufsize);
1039 buffer = (char **)va_arg(*p_va, char **);
1040 format++;
1041 if (buffer == NULL)
1042 return converterr("(buffer is NULL)",
1043 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001044
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001045 /* Encode object */
1046 if (!recode_strings &&
1047 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1048 s = arg;
1049 Py_INCREF(s);
1050 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1051 return converterr("(AsCharBuffer failed)",
1052 arg, msgbuf, bufsize);
1053 }
1054 else {
1055 PyObject *u;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001056
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001057 /* Convert object to Unicode */
1058 u = PyUnicode_FromObject(arg);
1059 if (u == NULL)
1060 return converterr(
1061 "string or unicode or text buffer",
1062 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001063
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001064 /* Encode object; use default error handling */
1065 s = PyUnicode_AsEncodedString(u,
1066 encoding,
1067 NULL);
1068 Py_DECREF(u);
1069 if (s == NULL)
1070 return converterr("(encoding failed)",
1071 arg, msgbuf, bufsize);
1072 if (!PyBytes_Check(s)) {
1073 Py_DECREF(s);
1074 return converterr(
1075 "(encoder failed to return bytes)",
1076 arg, msgbuf, bufsize);
1077 }
1078 size = PyBytes_GET_SIZE(s);
1079 ptr = PyBytes_AS_STRING(s);
1080 if (ptr == NULL)
1081 ptr = "";
1082 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001084 /* Write output; output is guaranteed to be 0-terminated */
1085 if (*format == '#') {
1086 /* Using buffer length parameter '#':
1087
1088 - if *buffer is NULL, a new buffer of the
1089 needed size is allocated and the data
1090 copied into it; *buffer is updated to point
1091 to the new buffer; the caller is
1092 responsible for PyMem_Free()ing it after
1093 usage
1094
1095 - if *buffer is not NULL, the data is
1096 copied to *buffer; *buffer_len has to be
1097 set to the size of the buffer on input;
1098 buffer overflow is signalled with an error;
1099 buffer has to provide enough room for the
1100 encoded string plus the trailing 0-byte
1101
1102 - in both cases, *buffer_len is updated to
1103 the size of the buffer /excluding/ the
1104 trailing 0-byte
1105
1106 */
1107 FETCH_SIZE;
1108
1109 format++;
1110 if (q == NULL && q2 == NULL) {
1111 Py_DECREF(s);
1112 return converterr(
1113 "(buffer_len is NULL)",
1114 arg, msgbuf, bufsize);
1115 }
1116 if (*buffer == NULL) {
1117 *buffer = PyMem_NEW(char, size + 1);
1118 if (*buffer == NULL) {
1119 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001120 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001121 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 }
Victor Stinnera093d0d2011-01-04 11:16:48 +00001123 if (addcleanup(*buffer, freelist, 0)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001124 Py_DECREF(s);
1125 return converterr(
1126 "(cleanup problem)",
1127 arg, msgbuf, bufsize);
1128 }
1129 } else {
1130 if (size + 1 > BUFFER_LEN) {
1131 Py_DECREF(s);
1132 return converterr(
1133 "(buffer overflow)",
1134 arg, msgbuf, bufsize);
1135 }
1136 }
1137 memcpy(*buffer, ptr, size+1);
1138 STORE_SIZE(size);
1139 } else {
1140 /* Using a 0-terminated buffer:
1141
1142 - the encoded string has to be 0-terminated
1143 for this variant to work; if it is not, an
1144 error raised
1145
1146 - a new buffer of the needed size is
1147 allocated and the data copied into it;
1148 *buffer is updated to point to the new
1149 buffer; the caller is responsible for
1150 PyMem_Free()ing it after usage
1151
1152 */
1153 if ((Py_ssize_t)strlen(ptr) != size) {
1154 Py_DECREF(s);
1155 return converterr(
1156 "encoded string without NULL bytes",
1157 arg, msgbuf, bufsize);
1158 }
1159 *buffer = PyMem_NEW(char, size + 1);
1160 if (*buffer == NULL) {
1161 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001162 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001163 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001164 }
Victor Stinnera093d0d2011-01-04 11:16:48 +00001165 if (addcleanup(*buffer, freelist, 0)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 Py_DECREF(s);
1167 return converterr("(cleanup problem)",
1168 arg, msgbuf, bufsize);
1169 }
1170 memcpy(*buffer, ptr, size+1);
1171 }
1172 Py_DECREF(s);
1173 break;
1174 }
1175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001176 case 'S': { /* PyBytes object */
1177 PyObject **p = va_arg(*p_va, PyObject **);
1178 if (PyBytes_Check(arg))
1179 *p = arg;
1180 else
1181 return converterr("bytes", arg, msgbuf, bufsize);
1182 break;
1183 }
1184
1185 case 'Y': { /* PyByteArray object */
1186 PyObject **p = va_arg(*p_va, PyObject **);
1187 if (PyByteArray_Check(arg))
1188 *p = arg;
1189 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001190 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001191 break;
1192 }
1193
1194 case 'U': { /* PyUnicode object */
1195 PyObject **p = va_arg(*p_va, PyObject **);
1196 if (PyUnicode_Check(arg))
1197 *p = arg;
1198 else
1199 return converterr("str", arg, msgbuf, bufsize);
1200 break;
1201 }
1202
1203 case 'O': { /* object */
1204 PyTypeObject *type;
1205 PyObject **p;
1206 if (*format == '!') {
1207 type = va_arg(*p_va, PyTypeObject*);
1208 p = va_arg(*p_va, PyObject **);
1209 format++;
1210 if (PyType_IsSubtype(arg->ob_type, type))
1211 *p = arg;
1212 else
1213 return converterr(type->tp_name, arg, msgbuf, bufsize);
1214
1215 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 else if (*format == '&') {
1217 typedef int (*converter)(PyObject *, void *);
1218 converter convert = va_arg(*p_va, converter);
1219 void *addr = va_arg(*p_va, void *);
1220 int res;
1221 format++;
1222 if (! (res = (*convert)(arg, addr)))
1223 return converterr("(unspecified)",
1224 arg, msgbuf, bufsize);
1225 if (res == Py_CLEANUP_SUPPORTED &&
1226 addcleanup_convert(addr, freelist, convert) == -1)
1227 return converterr("(cleanup problem)",
1228 arg, msgbuf, bufsize);
1229 }
1230 else {
1231 p = va_arg(*p_va, PyObject **);
1232 *p = arg;
1233 }
1234 break;
1235 }
1236
1237
Victor Stinner25e8ec42010-06-25 00:02:38 +00001238 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001239 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240
Victor Stinner25e8ec42010-06-25 00:02:38 +00001241 if (*format != '*')
1242 return converterr(
1243 "invalid use of 'w' format character",
1244 arg, msgbuf, bufsize);
1245 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001246
Victor Stinner25e8ec42010-06-25 00:02:38 +00001247 /* Caller is interested in Py_buffer, and the object
1248 supports it directly. */
1249 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1250 PyErr_Clear();
1251 return converterr("read-write buffer", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001252 }
Victor Stinner8182b712010-07-28 00:40:58 +00001253 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1254 PyBuffer_Release((Py_buffer*)p);
1255 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1256 }
Victor Stinnera093d0d2011-01-04 11:16:48 +00001257 if (addcleanup(p, freelist, 1)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001258 return converterr(
1259 "(cleanup problem)",
1260 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001261 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001262 break;
1263 }
1264
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001265 default:
1266 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
1267
1268 }
1269
1270 *p_format = format;
1271 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001272
1273#undef FETCH_SIZE
1274#undef STORE_SIZE
1275#undef BUFFER_LEN
1276#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001277}
Guido van Rossumaa354651996-08-19 19:32:04 +00001278
Martin v. Löwis18e16552006-02-15 17:27:45 +00001279static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001280convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001281{
Victor Stinner5cb62392010-06-06 20:27:51 +00001282 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001283 Py_ssize_t count;
1284 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001285
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001286 *errmsg = NULL;
1287 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001288 if (pb != NULL && pb->bf_releasebuffer != NULL) {
1289 *errmsg = "read-only pinned buffer";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001290 return -1;
1291 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001292
Victor Stinner8182b712010-07-28 00:40:58 +00001293 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001294 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001295 count = view.len;
1296 *p = view.buf;
1297 PyBuffer_Release(&view);
1298 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001299}
Guido van Rossumaa354651996-08-19 19:32:04 +00001300
Martin v. Löwis423be952008-08-13 15:53:07 +00001301static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001302getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001303{
Victor Stinner8182b712010-07-28 00:40:58 +00001304 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 *errmsg = "bytes or buffer";
1306 return -1;
1307 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001308 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001309 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001310 *errmsg = "contiguous buffer";
1311 return -1;
1312 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001313 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001314}
1315
Guido van Rossumaa354651996-08-19 19:32:04 +00001316/* Support for keyword arguments donated by
1317 Geoff Philbrick <philbric@delphi.hks.com> */
1318
Tim Petersf8cd3e82001-10-27 04:26:57 +00001319/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001320int
1321PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001322 PyObject *keywords,
1323 const char *format,
1324 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001325{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001326 int retval;
1327 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001328
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 if ((args == NULL || !PyTuple_Check(args)) ||
1330 (keywords != NULL && !PyDict_Check(keywords)) ||
1331 format == NULL ||
1332 kwlist == NULL)
1333 {
1334 PyErr_BadInternalCall();
1335 return 0;
1336 }
Tim Peters45772cd2001-10-27 03:58:40 +00001337
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001338 va_start(va, kwlist);
1339 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1340 va_end(va);
1341 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001342}
1343
1344int
1345_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 PyObject *keywords,
1347 const char *format,
1348 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001349{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001350 int retval;
1351 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 if ((args == NULL || !PyTuple_Check(args)) ||
1354 (keywords != NULL && !PyDict_Check(keywords)) ||
1355 format == NULL ||
1356 kwlist == NULL)
1357 {
1358 PyErr_BadInternalCall();
1359 return 0;
1360 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001361
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001362 va_start(va, kwlist);
1363 retval = vgetargskeywords(args, keywords, format,
1364 kwlist, &va, FLAG_SIZE_T);
1365 va_end(va);
1366 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001367}
1368
1369
Brett Cannon711e7d92004-07-10 22:20:32 +00001370int
1371PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001372 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001373 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001374 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001375{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001376 int retval;
1377 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 if ((args == NULL || !PyTuple_Check(args)) ||
1380 (keywords != NULL && !PyDict_Check(keywords)) ||
1381 format == NULL ||
1382 kwlist == NULL)
1383 {
1384 PyErr_BadInternalCall();
1385 return 0;
1386 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001387
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001388 Py_VA_COPY(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1391 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001392}
1393
1394int
1395_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001396 PyObject *keywords,
1397 const char *format,
1398 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001399{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 int retval;
1401 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 if ((args == NULL || !PyTuple_Check(args)) ||
1404 (keywords != NULL && !PyDict_Check(keywords)) ||
1405 format == NULL ||
1406 kwlist == NULL)
1407 {
1408 PyErr_BadInternalCall();
1409 return 0;
1410 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001411
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001412 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001413
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 retval = vgetargskeywords(args, keywords, format,
1415 kwlist, &lva, FLAG_SIZE_T);
1416 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001417}
1418
Benjamin Petersonfb886362010-04-24 18:21:17 +00001419int
1420PyArg_ValidateKeywordArguments(PyObject *kwargs)
1421{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001422 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001423 PyErr_BadInternalCall();
1424 return 0;
1425 }
1426 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1427 PyErr_SetString(PyExc_TypeError,
1428 "keyword arguments must be strings");
1429 return 0;
1430 }
1431 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001432}
1433
Christian Heimes380f7f22008-02-28 11:19:05 +00001434#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001435
Guido van Rossumaa354651996-08-19 19:32:04 +00001436static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001437vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001438 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001439{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001440 char msgbuf[512];
1441 int levels[32];
1442 const char *fname, *msg, *custom_msg, *keyword;
1443 int min = INT_MAX;
1444 int i, len, nargs, nkeywords;
1445 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001447 assert(args != NULL && PyTuple_Check(args));
1448 assert(keywords == NULL || PyDict_Check(keywords));
1449 assert(format != NULL);
1450 assert(kwlist != NULL);
1451 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001452
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 /* grab the function name or custom error msg first (mutually exclusive) */
1454 fname = strchr(format, ':');
1455 if (fname) {
1456 fname++;
1457 custom_msg = NULL;
1458 }
1459 else {
1460 custom_msg = strchr(format,';');
1461 if (custom_msg)
1462 custom_msg++;
1463 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001465 /* scan kwlist and get greatest possible nbr of args */
1466 for (len=0; kwlist[len]; len++)
1467 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 nargs = PyTuple_GET_SIZE(args);
1470 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1471 if (nargs + nkeywords > len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +01001472 PyErr_Format(PyExc_TypeError,
1473 "%s%s takes at most %d argument%s (%d given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 (fname == NULL) ? "function" : fname,
1475 (fname == NULL) ? "" : "()",
1476 len,
1477 (len == 1) ? "" : "s",
1478 nargs + nkeywords);
1479 return 0;
1480 }
Tim Petersc2f01122001-10-27 07:25:06 +00001481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1483 for (i = 0; i < len; i++) {
1484 keyword = kwlist[i];
1485 if (*format == '|') {
1486 min = i;
1487 format++;
1488 }
1489 if (IS_END_OF_FORMAT(*format)) {
1490 PyErr_Format(PyExc_RuntimeError,
1491 "More keyword list entries (%d) than "
1492 "format specifiers (%d)", len, i);
1493 return cleanreturn(0, freelist);
1494 }
1495 current_arg = NULL;
1496 if (nkeywords) {
1497 current_arg = PyDict_GetItemString(keywords, keyword);
1498 }
1499 if (current_arg) {
1500 --nkeywords;
1501 if (i < nargs) {
1502 /* arg present in tuple and in dict */
1503 PyErr_Format(PyExc_TypeError,
1504 "Argument given by name ('%s') "
1505 "and position (%d)",
1506 keyword, i+1);
1507 return cleanreturn(0, freelist);
1508 }
1509 }
1510 else if (nkeywords && PyErr_Occurred())
1511 return cleanreturn(0, freelist);
1512 else if (i < nargs)
1513 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimes380f7f22008-02-28 11:19:05 +00001514
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001515 if (current_arg) {
1516 msg = convertitem(current_arg, &format, p_va, flags,
1517 levels, msgbuf, sizeof(msgbuf), &freelist);
1518 if (msg) {
1519 seterror(i+1, msg, levels, fname, custom_msg);
1520 return cleanreturn(0, freelist);
1521 }
1522 continue;
1523 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 if (i < min) {
1526 PyErr_Format(PyExc_TypeError, "Required argument "
1527 "'%s' (pos %d) not found",
1528 keyword, i+1);
1529 return cleanreturn(0, freelist);
1530 }
1531 /* current code reports success when all required args
1532 * fulfilled and no keyword args left, with no further
1533 * validation. XXX Maybe skip this in debug build ?
1534 */
1535 if (!nkeywords)
1536 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001538 /* We are into optional args, skip thru to any remaining
1539 * keyword args */
1540 msg = skipitem(&format, p_va, flags);
1541 if (msg) {
1542 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1543 format);
1544 return cleanreturn(0, freelist);
1545 }
1546 }
Tim Petersb054be42001-10-27 05:07:41 +00001547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
1549 PyErr_Format(PyExc_RuntimeError,
1550 "more argument specifiers than keyword list entries "
1551 "(remaining format:'%s')", format);
1552 return cleanreturn(0, freelist);
1553 }
Tim Petersc2f01122001-10-27 07:25:06 +00001554
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001555 /* make sure there are no extraneous keyword arguments */
1556 if (nkeywords > 0) {
1557 PyObject *key, *value;
1558 Py_ssize_t pos = 0;
1559 while (PyDict_Next(keywords, &pos, &key, &value)) {
1560 int match = 0;
1561 char *ks;
1562 if (!PyUnicode_Check(key)) {
1563 PyErr_SetString(PyExc_TypeError,
1564 "keywords must be strings");
1565 return cleanreturn(0, freelist);
1566 }
Victor Stinner93b55132010-05-19 00:54:06 +00001567 /* check that _PyUnicode_AsString() result is not NULL */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001568 ks = _PyUnicode_AsString(key);
Victor Stinner93b55132010-05-19 00:54:06 +00001569 if (ks != NULL) {
1570 for (i = 0; i < len; i++) {
1571 if (!strcmp(ks, kwlist[i])) {
1572 match = 1;
1573 break;
1574 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001575 }
1576 }
1577 if (!match) {
1578 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001579 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001580 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001581 key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001582 return cleanreturn(0, freelist);
1583 }
1584 }
1585 }
1586
1587 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001588}
1589
1590
1591static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001592skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001593{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001594 const char *format = *p_format;
1595 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001596
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001598
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 /* simple codes
1600 * The individual types (second arg of va_arg) are irrelevant */
Georg Brandl6dd14612005-09-14 19:29:53 +00001601
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 case 'b': /* byte -- very short int */
1603 case 'B': /* byte as bitfield */
1604 case 'h': /* short int */
1605 case 'H': /* short int as bitfield */
1606 case 'i': /* int */
1607 case 'I': /* int sized bitfield */
1608 case 'l': /* long int */
1609 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001610#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 case 'L': /* PY_LONG_LONG */
1612 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001613#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001614 case 'f': /* float */
1615 case 'd': /* double */
1616 case 'D': /* complex double */
1617 case 'c': /* char */
1618 case 'C': /* unicode char */
1619 {
1620 (void) va_arg(*p_va, void *);
1621 break;
1622 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001623
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 case 'n': /* Py_ssize_t */
1625 {
1626 (void) va_arg(*p_va, Py_ssize_t *);
1627 break;
1628 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001629
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001631
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 case 'e': /* string with encoding */
1633 {
1634 (void) va_arg(*p_va, const char *);
1635 if (!(*format == 's' || *format == 't'))
1636 /* after 'e', only 's' and 't' is allowed */
1637 goto err;
1638 format++;
1639 /* explicit fallthrough to string cases */
1640 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001641
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001642 case 's': /* string */
1643 case 'z': /* string or None */
1644 case 'y': /* bytes */
1645 case 'u': /* unicode string */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 case 'w': /* buffer, read-write */
1647 {
1648 (void) va_arg(*p_va, char **);
1649 if (*format == '#') {
1650 if (flags & FLAG_SIZE_T)
1651 (void) va_arg(*p_va, Py_ssize_t *);
1652 else
1653 (void) va_arg(*p_va, int *);
1654 format++;
1655 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1656 format++;
1657 }
1658 break;
1659 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 /* object codes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001662
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001663 case 'S': /* string object */
1664 case 'Y': /* string object */
1665 case 'U': /* unicode string object */
1666 {
1667 (void) va_arg(*p_va, PyObject **);
1668 break;
1669 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001671 case 'O': /* object */
1672 {
1673 if (*format == '!') {
1674 format++;
1675 (void) va_arg(*p_va, PyTypeObject*);
1676 (void) va_arg(*p_va, PyObject **);
1677 }
1678 else if (*format == '&') {
1679 typedef int (*converter)(PyObject *, void *);
1680 (void) va_arg(*p_va, converter);
1681 (void) va_arg(*p_va, void *);
1682 format++;
1683 }
1684 else {
1685 (void) va_arg(*p_va, PyObject **);
1686 }
1687 break;
1688 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001689
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001690 case '(': /* bypass tuple, not handled at all previously */
1691 {
1692 char *msg;
1693 for (;;) {
1694 if (*format==')')
1695 break;
1696 if (IS_END_OF_FORMAT(*format))
1697 return "Unmatched left paren in format "
1698 "string";
1699 msg = skipitem(&format, p_va, flags);
1700 if (msg)
1701 return msg;
1702 }
1703 format++;
1704 break;
1705 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001706
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001707 case ')':
1708 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00001709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001710 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001711err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001712 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001713
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001714 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001715
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001716 *p_format = format;
1717 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001718}
Fred Drakee4616e62001-10-23 21:09:29 +00001719
1720
1721int
Martin v. Löwis76246742006-03-01 04:06:10 +00001722PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001723{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001724 Py_ssize_t i, l;
1725 PyObject **o;
1726 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001727
1728#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001729 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001730#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001731 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001732#endif
1733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734 assert(min >= 0);
1735 assert(min <= max);
1736 if (!PyTuple_Check(args)) {
1737 PyErr_SetString(PyExc_SystemError,
1738 "PyArg_UnpackTuple() argument list is not a tuple");
1739 return 0;
1740 }
1741 l = PyTuple_GET_SIZE(args);
1742 if (l < min) {
1743 if (name != NULL)
1744 PyErr_Format(
1745 PyExc_TypeError,
1746 "%s expected %s%zd arguments, got %zd",
1747 name, (min == max ? "" : "at least "), min, l);
1748 else
1749 PyErr_Format(
1750 PyExc_TypeError,
1751 "unpacked tuple should have %s%zd elements,"
1752 " but has %zd",
1753 (min == max ? "" : "at least "), min, l);
1754 va_end(vargs);
1755 return 0;
1756 }
1757 if (l > max) {
1758 if (name != NULL)
1759 PyErr_Format(
1760 PyExc_TypeError,
1761 "%s expected %s%zd arguments, got %zd",
1762 name, (min == max ? "" : "at most "), max, l);
1763 else
1764 PyErr_Format(
1765 PyExc_TypeError,
1766 "unpacked tuple should have %s%zd elements,"
1767 " but has %zd",
1768 (min == max ? "" : "at most "), max, l);
1769 va_end(vargs);
1770 return 0;
1771 }
1772 for (i = 0; i < l; i++) {
1773 o = va_arg(vargs, PyObject **);
1774 *o = PyTuple_GET_ITEM(args, i);
1775 }
1776 va_end(vargs);
1777 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001778}
Georg Brandl02c42872005-08-26 06:42:30 +00001779
1780
1781/* For type constructors that don't take keyword args
1782 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001783 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001784 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001785 */
1786int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001787_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001788{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001789 if (kw == NULL)
1790 return 1;
1791 if (!PyDict_CheckExact(kw)) {
1792 PyErr_BadInternalCall();
1793 return 0;
1794 }
1795 if (PyDict_Size(kw) == 0)
1796 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001797
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001798 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1799 funcname);
1800 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001801}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001802#ifdef __cplusplus
1803};
1804#endif