blob: aac1d177a799ee412f490188f4e7729f2309b233 [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
Benjamin Petersonb173f782009-05-05 22:31:58 +0000149addcleanup(void *ptr, PyObject **freelist, PyCapsule_Destructor destr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000150{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000151 PyObject *cobj;
152 const char *name;
Benjamin Petersonb173f782009-05-05 22:31:58 +0000153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000154 if (!*freelist) {
155 *freelist = PyList_New(0);
156 if (!*freelist) {
157 destr(ptr);
158 return -1;
159 }
160 }
Benjamin Petersonb173f782009-05-05 22:31:58 +0000161
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000162 if (destr == cleanup_ptr) {
163 name = GETARGS_CAPSULE_NAME_CLEANUP_PTR;
164 } else if (destr == cleanup_buffer) {
165 name = GETARGS_CAPSULE_NAME_CLEANUP_BUFFER;
166 } else {
167 return -1;
168 }
169 cobj = PyCapsule_New(ptr, name, destr);
170 if (!cobj) {
171 destr(ptr);
172 return -1;
173 }
174 if (PyList_Append(*freelist, cobj)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000175 Py_DECREF(cobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 return -1;
177 }
178 Py_DECREF(cobj);
179 return 0;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000180}
181
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000182static void
183cleanup_convert(PyObject *self)
184{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000185 typedef int (*destr_t)(PyObject *, void *);
186 destr_t destr = (destr_t)PyCapsule_GetContext(self);
187 void *ptr = PyCapsule_GetPointer(self,
188 GETARGS_CAPSULE_NAME_CLEANUP_CONVERT);
189 if (ptr && destr)
190 destr(NULL, ptr);
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000191}
192
193static int
194addcleanup_convert(void *ptr, PyObject **freelist, int (*destr)(PyObject*,void*))
195{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000196 PyObject *cobj;
197 if (!*freelist) {
198 *freelist = PyList_New(0);
199 if (!*freelist) {
200 destr(NULL, ptr);
201 return -1;
202 }
203 }
204 cobj = PyCapsule_New(ptr, GETARGS_CAPSULE_NAME_CLEANUP_CONVERT,
205 cleanup_convert);
206 if (!cobj) {
207 destr(NULL, ptr);
208 return -1;
209 }
210 if (PyCapsule_SetContext(cobj, destr) == -1) {
211 /* This really should not happen. */
212 Py_FatalError("capsule refused setting of context.");
213 }
214 if (PyList_Append(*freelist, cobj)) {
215 Py_DECREF(cobj); /* This will also call destr. */
216 return -1;
217 }
218 Py_DECREF(cobj);
219 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000220}
221
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000222static int
223cleanreturn(int retval, PyObject *freelist)
224{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000225 if (freelist && retval != 0) {
226 /* We were successful, reset the destructors so that they
227 don't get called. */
228 Py_ssize_t len = PyList_GET_SIZE(freelist), i;
229 for (i = 0; i < len; i++)
230 PyCapsule_SetDestructor(PyList_GET_ITEM(freelist, i), NULL);
231 }
232 Py_XDECREF(freelist);
233 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000234}
235
236
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000237static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000238vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000239{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000240 char msgbuf[256];
241 int levels[32];
242 const char *fname = NULL;
243 const char *message = NULL;
244 int min = -1;
245 int max = 0;
246 int level = 0;
247 int endfmt = 0;
248 const char *formatsave = format;
249 Py_ssize_t i, len;
250 char *msg;
251 PyObject *freelist = NULL;
252 int compat = flags & FLAG_COMPAT;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000253
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000254 assert(compat || (args != (PyObject*)NULL));
255 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000256
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000257 while (endfmt == 0) {
258 int c = *format++;
259 switch (c) {
260 case '(':
261 if (level == 0)
262 max++;
263 level++;
264 if (level >= 30)
265 Py_FatalError("too many tuple nesting levels "
266 "in argument format string");
267 break;
268 case ')':
269 if (level == 0)
270 Py_FatalError("excess ')' in getargs format");
271 else
272 level--;
273 break;
274 case '\0':
275 endfmt = 1;
276 break;
277 case ':':
278 fname = format;
279 endfmt = 1;
280 break;
281 case ';':
282 message = format;
283 endfmt = 1;
284 break;
285 default:
286 if (level == 0) {
287 if (c == 'O')
288 max++;
289 else if (isalpha(Py_CHARMASK(c))) {
290 if (c != 'e') /* skip encoded */
291 max++;
292 } else if (c == '|')
293 min = max;
294 }
295 break;
296 }
297 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 if (level != 0)
300 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000301
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000302 if (min < 0)
303 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000305 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 if (compat) {
308 if (max == 0) {
309 if (args == NULL)
310 return 1;
311 PyOS_snprintf(msgbuf, sizeof(msgbuf),
312 "%.200s%s takes no arguments",
313 fname==NULL ? "function" : fname,
314 fname==NULL ? "" : "()");
315 PyErr_SetString(PyExc_TypeError, msgbuf);
316 return 0;
317 }
318 else if (min == 1 && max == 1) {
319 if (args == NULL) {
320 PyOS_snprintf(msgbuf, sizeof(msgbuf),
321 "%.200s%s takes at least one argument",
322 fname==NULL ? "function" : fname,
323 fname==NULL ? "" : "()");
324 PyErr_SetString(PyExc_TypeError, msgbuf);
325 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) {
350 if (message == NULL) {
351 PyOS_snprintf(msgbuf, sizeof(msgbuf),
352 "%.150s%s takes %s %d argument%s "
353 "(%ld given)",
354 fname==NULL ? "function" : fname,
355 fname==NULL ? "" : "()",
356 min==max ? "exactly"
357 : len < min ? "at least" : "at most",
358 len < min ? min : max,
359 (len < min ? min : max) == 1 ? "" : "s",
360 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
361 message = msgbuf;
362 }
363 PyErr_SetString(PyExc_TypeError, message);
364 return 0;
365 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 for (i = 0; i < len; i++) {
368 if (*format == '|')
369 format++;
370 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
371 flags, levels, msgbuf,
372 sizeof(msgbuf), &freelist);
373 if (msg) {
374 seterror(i+1, msg, levels, fname, msg);
375 return cleanreturn(0, freelist);
376 }
377 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000379 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
380 *format != '(' &&
381 *format != '|' && *format != ':' && *format != ';') {
382 PyErr_Format(PyExc_SystemError,
383 "bad format string: %.200s", formatsave);
384 return cleanreturn(0, freelist);
385 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000386
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000387 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000388}
389
390
391
392static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000393seterror(int iarg, const char *msg, int *levels, const char *fname,
394 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000395{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000396 char buf[512];
397 int i;
398 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000399
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 if (PyErr_Occurred())
401 return;
402 else if (message == NULL) {
403 if (fname != NULL) {
404 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
405 p += strlen(p);
406 }
407 if (iarg != 0) {
408 PyOS_snprintf(p, sizeof(buf) - (p - buf),
409 "argument %d", iarg);
410 i = 0;
411 p += strlen(p);
412 while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
413 PyOS_snprintf(p, sizeof(buf) - (p - buf),
414 ", item %d", levels[i]-1);
415 p += strlen(p);
416 i++;
417 }
418 }
419 else {
420 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
421 p += strlen(p);
422 }
423 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
424 message = buf;
425 }
426 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000427}
428
429
430/* Convert a tuple argument.
431 On entry, *p_format points to the character _after_ the opening '('.
432 On successful exit, *p_format points to the closing ')'.
433 If successful:
434 *p_format and *p_va are updated,
435 *levels and *msgbuf are untouched,
436 and NULL is returned.
437 If the argument is invalid:
438 *p_format is unchanged,
439 *p_va is undefined,
440 *levels is a 0-terminated list of item numbers,
441 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 "must be <typename1>, not <typename2>", where:
443 <typename1> is the name of the expected type, and
444 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000445 and msgbuf is returned.
446*/
447
448static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000449converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000450 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000451 PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000452{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000453 int level = 0;
454 int n = 0;
455 const char *format = *p_format;
456 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000457
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000458 for (;;) {
459 int c = *format++;
460 if (c == '(') {
461 if (level == 0)
462 n++;
463 level++;
464 }
465 else if (c == ')') {
466 if (level == 0)
467 break;
468 level--;
469 }
470 else if (c == ':' || c == ';' || c == '\0')
471 break;
472 else if (level == 0 && isalpha(Py_CHARMASK(c)))
473 n++;
474 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000475
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
477 levels[0] = 0;
478 PyOS_snprintf(msgbuf, bufsize,
479 toplevel ? "expected %d arguments, not %.50s" :
480 "must be %d-item sequence, not %.50s",
481 n,
482 arg == Py_None ? "None" : arg->ob_type->tp_name);
483 return msgbuf;
484 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000486 if ((i = PySequence_Size(arg)) != n) {
487 levels[0] = 0;
488 PyOS_snprintf(msgbuf, bufsize,
489 toplevel ? "expected %d arguments, not %d" :
490 "must be sequence of length %d, not %d",
491 n, i);
492 return msgbuf;
493 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000494
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000495 format = *p_format;
496 for (i = 0; i < n; i++) {
497 char *msg;
498 PyObject *item;
499 item = PySequence_GetItem(arg, i);
500 if (item == NULL) {
501 PyErr_Clear();
502 levels[0] = i+1;
503 levels[1] = 0;
504 strncpy(msgbuf, "is not retrievable", bufsize);
505 return msgbuf;
506 }
507 msg = convertitem(item, &format, p_va, flags, levels+1,
508 msgbuf, bufsize, freelist);
509 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
510 Py_XDECREF(item);
511 if (msg != NULL) {
512 levels[0] = i+1;
513 return msg;
514 }
515 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 *p_format = format;
518 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000519}
520
521
522/* Convert a single item. */
523
524static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000525convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
526 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000527{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000528 char *msg;
529 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000531 if (*format == '(' /* ')' */) {
532 format++;
533 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
534 bufsize, 0, freelist);
535 if (msg == NULL)
536 format++;
537 }
538 else {
539 msg = convertsimple(arg, &format, p_va, flags,
540 msgbuf, bufsize, freelist);
541 if (msg != NULL)
542 levels[0] = 0;
543 }
544 if (msg == NULL)
545 *p_format = format;
546 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000547}
548
549
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000550
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000551#define UNICODE_DEFAULT_ENCODING(arg) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000552 _PyUnicode_AsDefaultEncodedString(arg, NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000553
554/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000555
556static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000557converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000558{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000559 assert(expected != NULL);
560 assert(arg != NULL);
561 PyOS_snprintf(msgbuf, bufsize,
562 "must be %.50s, not %.50s", expected,
563 arg == Py_None ? "None" : arg->ob_type->tp_name);
564 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000565}
566
567#define CONV_UNICODE "(unicode conversion error)"
568
Guido van Rossum45aecf42006-03-15 04:58:47 +0000569/* Explicitly check for float arguments when integers are expected.
570 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000571static int
572float_argument_error(PyObject *arg)
573{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000574 if (PyFloat_Check(arg)) {
575 PyErr_SetString(PyExc_TypeError,
576 "integer argument expected, got float" );
577 return 1;
578 }
579 else
580 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000581}
582
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000583/* Convert a non-tuple argument. Return NULL if conversion went OK,
584 or a string with a message describing the failure. The message is
585 formatted as "must be <desired type>, not <actual type>".
586 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000587 Don't call if a tuple is expected.
588
589 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000590*/
591
592static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000593convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000594 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000595{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000596 /* For # codes */
597#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
598 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
599 else q=va_arg(*p_va, int*);
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000600#define STORE_SIZE(s) \
601 if (flags & FLAG_SIZE_T) \
602 *q2=s; \
603 else { \
604 if (INT_MAX < s) { \
605 PyErr_SetString(PyExc_OverflowError, \
606 "size does not fit in an int"); \
607 return converterr("", arg, msgbuf, bufsize); \
608 } \
609 *q=s; \
610 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000611#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
612
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000613 const char *format = *p_format;
614 char c = *format++;
615 PyObject *uarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000617 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 case 'b': { /* unsigned byte -- very short int */
620 char *p = va_arg(*p_va, char *);
621 long ival;
622 if (float_argument_error(arg))
623 return converterr("integer<b>", arg, msgbuf, bufsize);
624 ival = PyLong_AsLong(arg);
625 if (ival == -1 && PyErr_Occurred())
626 return converterr("integer<b>", arg, msgbuf, bufsize);
627 else if (ival < 0) {
628 PyErr_SetString(PyExc_OverflowError,
629 "unsigned byte integer is less than minimum");
630 return converterr("integer<b>", arg, msgbuf, bufsize);
631 }
632 else if (ival > UCHAR_MAX) {
633 PyErr_SetString(PyExc_OverflowError,
634 "unsigned byte integer is greater than maximum");
635 return converterr("integer<b>", arg, msgbuf, bufsize);
636 }
637 else
638 *p = (unsigned char) ival;
639 break;
640 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000641
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000642 case 'B': {/* byte sized bitfield - both signed and unsigned
643 values allowed */
644 char *p = va_arg(*p_va, char *);
645 long ival;
646 if (float_argument_error(arg))
647 return converterr("integer<B>", arg, msgbuf, bufsize);
648 ival = PyLong_AsUnsignedLongMask(arg);
649 if (ival == -1 && PyErr_Occurred())
650 return converterr("integer<B>", arg, msgbuf, bufsize);
651 else
652 *p = (unsigned char) ival;
653 break;
654 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000655
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000656 case 'h': {/* signed short int */
657 short *p = va_arg(*p_va, short *);
658 long ival;
659 if (float_argument_error(arg))
660 return converterr("integer<h>", arg, msgbuf, bufsize);
661 ival = PyLong_AsLong(arg);
662 if (ival == -1 && PyErr_Occurred())
663 return converterr("integer<h>", arg, msgbuf, bufsize);
664 else if (ival < SHRT_MIN) {
665 PyErr_SetString(PyExc_OverflowError,
666 "signed short integer is less than minimum");
667 return converterr("integer<h>", arg, msgbuf, bufsize);
668 }
669 else if (ival > SHRT_MAX) {
670 PyErr_SetString(PyExc_OverflowError,
671 "signed short integer is greater than maximum");
672 return converterr("integer<h>", arg, msgbuf, bufsize);
673 }
674 else
675 *p = (short) ival;
676 break;
677 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000679 case 'H': { /* short int sized bitfield, both signed and
680 unsigned allowed */
681 unsigned short *p = va_arg(*p_va, unsigned short *);
682 long ival;
683 if (float_argument_error(arg))
684 return converterr("integer<H>", arg, msgbuf, bufsize);
685 ival = PyLong_AsUnsignedLongMask(arg);
686 if (ival == -1 && PyErr_Occurred())
687 return converterr("integer<H>", arg, msgbuf, bufsize);
688 else
689 *p = (unsigned short) ival;
690 break;
691 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000693 case 'i': {/* signed int */
694 int *p = va_arg(*p_va, int *);
695 long ival;
696 if (float_argument_error(arg))
697 return converterr("integer<i>", arg, msgbuf, bufsize);
698 ival = PyLong_AsLong(arg);
699 if (ival == -1 && PyErr_Occurred())
700 return converterr("integer<i>", arg, msgbuf, bufsize);
701 else if (ival > INT_MAX) {
702 PyErr_SetString(PyExc_OverflowError,
703 "signed integer is greater than maximum");
704 return converterr("integer<i>", arg, msgbuf, bufsize);
705 }
706 else if (ival < INT_MIN) {
707 PyErr_SetString(PyExc_OverflowError,
708 "signed integer is less than minimum");
709 return converterr("integer<i>", arg, msgbuf, bufsize);
710 }
711 else
712 *p = ival;
713 break;
714 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000715
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000716 case 'I': { /* int sized bitfield, both signed and
717 unsigned allowed */
718 unsigned int *p = va_arg(*p_va, unsigned int *);
719 unsigned int ival;
720 if (float_argument_error(arg))
721 return converterr("integer<I>", arg, msgbuf, bufsize);
722 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
723 if (ival == (unsigned int)-1 && PyErr_Occurred())
724 return converterr("integer<I>", arg, msgbuf, bufsize);
725 else
726 *p = ival;
727 break;
728 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000729
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 case 'n': /* Py_ssize_t */
731 {
732 PyObject *iobj;
733 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
734 Py_ssize_t ival = -1;
735 if (float_argument_error(arg))
736 return converterr("integer<n>", arg, msgbuf, bufsize);
737 iobj = PyNumber_Index(arg);
738 if (iobj != NULL) {
739 ival = PyLong_AsSsize_t(iobj);
740 Py_DECREF(iobj);
741 }
742 if (ival == -1 && PyErr_Occurred())
743 return converterr("integer<n>", arg, msgbuf, bufsize);
744 *p = ival;
745 break;
746 }
747 case 'l': {/* long int */
748 long *p = va_arg(*p_va, long *);
749 long ival;
750 if (float_argument_error(arg))
751 return converterr("integer<l>", arg, msgbuf, bufsize);
752 ival = PyLong_AsLong(arg);
753 if (ival == -1 && PyErr_Occurred())
754 return converterr("integer<l>", arg, msgbuf, bufsize);
755 else
756 *p = ival;
757 break;
758 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000759
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 case 'k': { /* long sized bitfield */
761 unsigned long *p = va_arg(*p_va, unsigned long *);
762 unsigned long ival;
763 if (PyLong_Check(arg))
764 ival = PyLong_AsUnsignedLongMask(arg);
765 else
766 return converterr("integer<k>", arg, msgbuf, bufsize);
767 *p = ival;
768 break;
769 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000770
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000771#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000772 case 'L': {/* PY_LONG_LONG */
773 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
774 PY_LONG_LONG ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000775 if (float_argument_error(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000776 return converterr("long<L>", arg, msgbuf, bufsize);
777 ival = PyLong_AsLongLong(arg);
Mark Dickinsonc7301312010-06-10 16:05:10 +0000778 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred())
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000779 return converterr("long<L>", arg, msgbuf, bufsize);
Mark Dickinsonc7301312010-06-10 16:05:10 +0000780 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000782 break;
783 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000784
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000785 case 'K': { /* long long sized bitfield */
786 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
787 unsigned PY_LONG_LONG ival;
788 if (PyLong_Check(arg))
789 ival = PyLong_AsUnsignedLongLongMask(arg);
790 else
791 return converterr("integer<K>", arg, msgbuf, bufsize);
792 *p = ival;
793 break;
794 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000795#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000796
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000797 case 'f': {/* float */
798 float *p = va_arg(*p_va, float *);
799 double dval = PyFloat_AsDouble(arg);
800 if (PyErr_Occurred())
801 return converterr("float<f>", arg, msgbuf, bufsize);
802 else
803 *p = (float) dval;
804 break;
805 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000806
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000807 case 'd': {/* double */
808 double *p = va_arg(*p_va, double *);
809 double dval = PyFloat_AsDouble(arg);
810 if (PyErr_Occurred())
811 return converterr("float<d>", arg, msgbuf, bufsize);
812 else
813 *p = dval;
814 break;
815 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000816
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000817 case 'D': {/* complex double */
818 Py_complex *p = va_arg(*p_va, Py_complex *);
819 Py_complex cval;
820 cval = PyComplex_AsCComplex(arg);
821 if (PyErr_Occurred())
822 return converterr("complex<D>", arg, msgbuf, bufsize);
823 else
824 *p = cval;
825 break;
826 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000827
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 case 'c': {/* char */
829 char *p = va_arg(*p_va, char *);
830 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
831 *p = PyBytes_AS_STRING(arg)[0];
832 else
833 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
834 break;
835 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000836
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000837 case 'C': {/* unicode char */
838 int *p = va_arg(*p_va, int *);
839 if (PyUnicode_Check(arg) &&
840 PyUnicode_GET_SIZE(arg) == 1)
841 *p = PyUnicode_AS_UNICODE(arg)[0];
842 else
843 return converterr("a unicode character", arg, msgbuf, bufsize);
844 break;
845 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000846
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000847 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000849
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000850 case 'y': {/* any buffer-like object, but not PyUnicode */
851 void **p = (void **)va_arg(*p_va, char **);
852 char *buf;
853 Py_ssize_t count;
854 if (*format == '*') {
855 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
856 return converterr(buf, arg, msgbuf, bufsize);
857 format++;
858 if (addcleanup(p, freelist, cleanup_buffer)) {
859 return converterr(
860 "(cleanup problem)",
861 arg, msgbuf, bufsize);
862 }
863 break;
864 }
865 count = convertbuffer(arg, p, &buf);
866 if (count < 0)
867 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000868 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 FETCH_SIZE;
870 STORE_SIZE(count);
871 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000872 } else {
873 if (strlen(*p) != count)
874 return converterr(
875 "bytes without null bytes",
876 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000877 }
878 break;
879 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000880
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000881 case 's': /* text string */
882 case 'z': /* text string or None */
883 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000885 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000886 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000887
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000888 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000889 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
890 else if (PyUnicode_Check(arg)) {
891 uarg = UNICODE_DEFAULT_ENCODING(arg);
892 if (uarg == NULL)
893 return converterr(CONV_UNICODE,
894 arg, msgbuf, bufsize);
895 PyBuffer_FillInfo(p, arg,
896 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
897 1, 0);
898 }
899 else { /* any buffer-like object */
900 char *buf;
901 if (getbuffer(arg, p, &buf) < 0)
902 return converterr(buf, arg, msgbuf, bufsize);
903 }
904 if (addcleanup(p, freelist, cleanup_buffer)) {
905 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)) {
920 uarg = UNICODE_DEFAULT_ENCODING(arg);
921 if (uarg == NULL)
922 return converterr(CONV_UNICODE,
923 arg, msgbuf, bufsize);
924 *p = PyBytes_AS_STRING(uarg);
925 STORE_SIZE(PyBytes_GET_SIZE(uarg));
926 }
927 else { /* any buffer-like object */
928 /* XXX Really? */
929 char *buf;
930 Py_ssize_t count = convertbuffer(arg, p, &buf);
931 if (count < 0)
932 return converterr(buf, arg, msgbuf, bufsize);
933 STORE_SIZE(count);
934 }
935 format++;
936 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000937 /* "s" or "z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000938 char **p = va_arg(*p_va, char **);
939 uarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000940
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000941 if (c == 'z' && arg == Py_None)
942 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000943 else if (PyUnicode_Check(arg)) {
944 uarg = UNICODE_DEFAULT_ENCODING(arg);
945 if (uarg == NULL)
946 return converterr(CONV_UNICODE,
947 arg, msgbuf, bufsize);
948 *p = PyBytes_AS_STRING(uarg);
949 }
950 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000951 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000952 arg, msgbuf, bufsize);
Victor Stinner43fb0092010-05-29 00:13:06 +0000953 if (*p != NULL && uarg != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000954 (Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
955 return converterr(
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000956 c == 'z' ? "str without null bytes or None"
957 : "str without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 arg, msgbuf, bufsize);
959 }
960 break;
961 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000962
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000963 case 'u': /* raw unicode buffer (Py_UNICODE *) */
964 case 'Z': /* raw unicode buffer or None */
965 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000966 if (*format == '#') { /* any buffer-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000967 /* "s#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
969 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000970
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000971 if (c == 'Z' && arg == Py_None) {
972 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000973 STORE_SIZE(0);
974 }
975 else if (PyUnicode_Check(arg)) {
976 *p = PyUnicode_AS_UNICODE(arg);
977 STORE_SIZE(PyUnicode_GET_SIZE(arg));
978 }
Victor Stinner5216e6d2010-06-08 21:45:51 +0000979 else
980 return converterr("str or None", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 format++;
982 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000983 /* "s" or "Z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000984 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000985
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000986 if (c == 'Z' && arg == Py_None)
987 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000988 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000989 *p = PyUnicode_AS_UNICODE(arg);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000990 if (Py_UNICODE_strlen(*p) != PyUnicode_GET_SIZE(arg))
991 return converterr(
992 "str without null character or None",
993 arg, msgbuf, bufsize);
994 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000995 return converterr(c == 'Z' ? "str or None" : "str",
996 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000997 }
998 break;
999 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001000
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001001 case 'e': {/* encoded string */
1002 char **buffer;
1003 const char *encoding;
1004 PyObject *s;
1005 int recode_strings;
1006 Py_ssize_t size;
1007 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001008
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009 /* Get 'e' parameter: the encoding name */
1010 encoding = (const char *)va_arg(*p_va, const char *);
1011 if (encoding == NULL)
1012 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001013
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 /* Get output buffer parameter:
1015 's' (recode all objects via Unicode) or
1016 't' (only recode non-string objects)
1017 */
1018 if (*format == 's')
1019 recode_strings = 1;
1020 else if (*format == 't')
1021 recode_strings = 0;
1022 else
1023 return converterr(
1024 "(unknown parser marker combination)",
1025 arg, msgbuf, bufsize);
1026 buffer = (char **)va_arg(*p_va, char **);
1027 format++;
1028 if (buffer == NULL)
1029 return converterr("(buffer is NULL)",
1030 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001031
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001032 /* Encode object */
1033 if (!recode_strings &&
1034 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1035 s = arg;
1036 Py_INCREF(s);
1037 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1038 return converterr("(AsCharBuffer failed)",
1039 arg, msgbuf, bufsize);
1040 }
1041 else {
1042 PyObject *u;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001043
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001044 /* Convert object to Unicode */
1045 u = PyUnicode_FromObject(arg);
1046 if (u == NULL)
1047 return converterr(
1048 "string or unicode or text buffer",
1049 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001050
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001051 /* Encode object; use default error handling */
1052 s = PyUnicode_AsEncodedString(u,
1053 encoding,
1054 NULL);
1055 Py_DECREF(u);
1056 if (s == NULL)
1057 return converterr("(encoding failed)",
1058 arg, msgbuf, bufsize);
1059 if (!PyBytes_Check(s)) {
1060 Py_DECREF(s);
1061 return converterr(
1062 "(encoder failed to return bytes)",
1063 arg, msgbuf, bufsize);
1064 }
1065 size = PyBytes_GET_SIZE(s);
1066 ptr = PyBytes_AS_STRING(s);
1067 if (ptr == NULL)
1068 ptr = "";
1069 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001070
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001071 /* Write output; output is guaranteed to be 0-terminated */
1072 if (*format == '#') {
1073 /* Using buffer length parameter '#':
1074
1075 - if *buffer is NULL, a new buffer of the
1076 needed size is allocated and the data
1077 copied into it; *buffer is updated to point
1078 to the new buffer; the caller is
1079 responsible for PyMem_Free()ing it after
1080 usage
1081
1082 - if *buffer is not NULL, the data is
1083 copied to *buffer; *buffer_len has to be
1084 set to the size of the buffer on input;
1085 buffer overflow is signalled with an error;
1086 buffer has to provide enough room for the
1087 encoded string plus the trailing 0-byte
1088
1089 - in both cases, *buffer_len is updated to
1090 the size of the buffer /excluding/ the
1091 trailing 0-byte
1092
1093 */
1094 FETCH_SIZE;
1095
1096 format++;
1097 if (q == NULL && q2 == NULL) {
1098 Py_DECREF(s);
1099 return converterr(
1100 "(buffer_len is NULL)",
1101 arg, msgbuf, bufsize);
1102 }
1103 if (*buffer == NULL) {
1104 *buffer = PyMem_NEW(char, size + 1);
1105 if (*buffer == NULL) {
1106 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001107 PyErr_NoMemory();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001108 return converterr(
1109 "(memory error)",
1110 arg, msgbuf, bufsize);
1111 }
1112 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1113 Py_DECREF(s);
1114 return converterr(
1115 "(cleanup problem)",
1116 arg, msgbuf, bufsize);
1117 }
1118 } else {
1119 if (size + 1 > BUFFER_LEN) {
1120 Py_DECREF(s);
1121 return converterr(
1122 "(buffer overflow)",
1123 arg, msgbuf, bufsize);
1124 }
1125 }
1126 memcpy(*buffer, ptr, size+1);
1127 STORE_SIZE(size);
1128 } else {
1129 /* Using a 0-terminated buffer:
1130
1131 - the encoded string has to be 0-terminated
1132 for this variant to work; if it is not, an
1133 error raised
1134
1135 - a new buffer of the needed size is
1136 allocated and the data copied into it;
1137 *buffer is updated to point to the new
1138 buffer; the caller is responsible for
1139 PyMem_Free()ing it after usage
1140
1141 */
1142 if ((Py_ssize_t)strlen(ptr) != size) {
1143 Py_DECREF(s);
1144 return converterr(
1145 "encoded string without NULL bytes",
1146 arg, msgbuf, bufsize);
1147 }
1148 *buffer = PyMem_NEW(char, size + 1);
1149 if (*buffer == NULL) {
1150 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001151 PyErr_NoMemory();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001152 return converterr("(memory error)",
1153 arg, msgbuf, bufsize);
1154 }
1155 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1156 Py_DECREF(s);
1157 return converterr("(cleanup problem)",
1158 arg, msgbuf, bufsize);
1159 }
1160 memcpy(*buffer, ptr, size+1);
1161 }
1162 Py_DECREF(s);
1163 break;
1164 }
1165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 case 'S': { /* PyBytes object */
1167 PyObject **p = va_arg(*p_va, PyObject **);
1168 if (PyBytes_Check(arg))
1169 *p = arg;
1170 else
1171 return converterr("bytes", arg, msgbuf, bufsize);
1172 break;
1173 }
1174
1175 case 'Y': { /* PyByteArray object */
1176 PyObject **p = va_arg(*p_va, PyObject **);
1177 if (PyByteArray_Check(arg))
1178 *p = arg;
1179 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001180 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001181 break;
1182 }
1183
1184 case 'U': { /* PyUnicode object */
1185 PyObject **p = va_arg(*p_va, PyObject **);
1186 if (PyUnicode_Check(arg))
1187 *p = arg;
1188 else
1189 return converterr("str", arg, msgbuf, bufsize);
1190 break;
1191 }
1192
1193 case 'O': { /* object */
1194 PyTypeObject *type;
1195 PyObject **p;
1196 if (*format == '!') {
1197 type = va_arg(*p_va, PyTypeObject*);
1198 p = va_arg(*p_va, PyObject **);
1199 format++;
1200 if (PyType_IsSubtype(arg->ob_type, type))
1201 *p = arg;
1202 else
1203 return converterr(type->tp_name, arg, msgbuf, bufsize);
1204
1205 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001206 else if (*format == '&') {
1207 typedef int (*converter)(PyObject *, void *);
1208 converter convert = va_arg(*p_va, converter);
1209 void *addr = va_arg(*p_va, void *);
1210 int res;
1211 format++;
1212 if (! (res = (*convert)(arg, addr)))
1213 return converterr("(unspecified)",
1214 arg, msgbuf, bufsize);
1215 if (res == Py_CLEANUP_SUPPORTED &&
1216 addcleanup_convert(addr, freelist, convert) == -1)
1217 return converterr("(cleanup problem)",
1218 arg, msgbuf, bufsize);
1219 }
1220 else {
1221 p = va_arg(*p_va, PyObject **);
1222 *p = arg;
1223 }
1224 break;
1225 }
1226
1227
Victor Stinner25e8ec42010-06-25 00:02:38 +00001228 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001229 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001230
Victor Stinner25e8ec42010-06-25 00:02:38 +00001231 if (*format != '*')
1232 return converterr(
1233 "invalid use of 'w' format character",
1234 arg, msgbuf, bufsize);
1235 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001236
Victor Stinner25e8ec42010-06-25 00:02:38 +00001237 /* Caller is interested in Py_buffer, and the object
1238 supports it directly. */
1239 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1240 PyErr_Clear();
1241 return converterr("read-write buffer", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001242 }
Victor Stinner8182b712010-07-28 00:40:58 +00001243 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1244 PyBuffer_Release((Py_buffer*)p);
1245 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1246 }
Victor Stinner25e8ec42010-06-25 00:02:38 +00001247 if (addcleanup(p, freelist, cleanup_buffer)) {
1248 return converterr(
1249 "(cleanup problem)",
1250 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001251 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001252 break;
1253 }
1254
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001255 default:
1256 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
1257
1258 }
1259
1260 *p_format = format;
1261 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001262}
Guido van Rossumaa354651996-08-19 19:32:04 +00001263
Martin v. Löwis18e16552006-02-15 17:27:45 +00001264static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001265convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001266{
Victor Stinner5cb62392010-06-06 20:27:51 +00001267 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001268 Py_ssize_t count;
1269 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 *errmsg = NULL;
1272 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001273 if (pb != NULL && pb->bf_releasebuffer != NULL) {
1274 *errmsg = "read-only pinned buffer";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001275 return -1;
1276 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001277
Victor Stinner8182b712010-07-28 00:40:58 +00001278 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001279 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001280 count = view.len;
1281 *p = view.buf;
1282 PyBuffer_Release(&view);
1283 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001284}
Guido van Rossumaa354651996-08-19 19:32:04 +00001285
Martin v. Löwis423be952008-08-13 15:53:07 +00001286static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001287getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001288{
Victor Stinner8182b712010-07-28 00:40:58 +00001289 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001290 *errmsg = "bytes or buffer";
1291 return -1;
1292 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001293 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001294 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001295 *errmsg = "contiguous buffer";
1296 return -1;
1297 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001298 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001299}
1300
Guido van Rossumaa354651996-08-19 19:32:04 +00001301/* Support for keyword arguments donated by
1302 Geoff Philbrick <philbric@delphi.hks.com> */
1303
Tim Petersf8cd3e82001-10-27 04:26:57 +00001304/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001305int
1306PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001307 PyObject *keywords,
1308 const char *format,
1309 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001310{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001311 int retval;
1312 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001314 if ((args == NULL || !PyTuple_Check(args)) ||
1315 (keywords != NULL && !PyDict_Check(keywords)) ||
1316 format == NULL ||
1317 kwlist == NULL)
1318 {
1319 PyErr_BadInternalCall();
1320 return 0;
1321 }
Tim Peters45772cd2001-10-27 03:58:40 +00001322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001323 va_start(va, kwlist);
1324 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1325 va_end(va);
1326 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001327}
1328
1329int
1330_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001331 PyObject *keywords,
1332 const char *format,
1333 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001334{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001335 int retval;
1336 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001337
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001338 if ((args == NULL || !PyTuple_Check(args)) ||
1339 (keywords != NULL && !PyDict_Check(keywords)) ||
1340 format == NULL ||
1341 kwlist == NULL)
1342 {
1343 PyErr_BadInternalCall();
1344 return 0;
1345 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 va_start(va, kwlist);
1348 retval = vgetargskeywords(args, keywords, format,
1349 kwlist, &va, FLAG_SIZE_T);
1350 va_end(va);
1351 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001352}
1353
1354
Brett Cannon711e7d92004-07-10 22:20:32 +00001355int
1356PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001357 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001358 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001359 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001360{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001361 int retval;
1362 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001363
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001364 if ((args == NULL || !PyTuple_Check(args)) ||
1365 (keywords != NULL && !PyDict_Check(keywords)) ||
1366 format == NULL ||
1367 kwlist == NULL)
1368 {
1369 PyErr_BadInternalCall();
1370 return 0;
1371 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001372
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001373 Py_VA_COPY(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001374
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001375 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1376 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001377}
1378
1379int
1380_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 PyObject *keywords,
1382 const char *format,
1383 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001384{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001385 int retval;
1386 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001388 if ((args == NULL || !PyTuple_Check(args)) ||
1389 (keywords != NULL && !PyDict_Check(keywords)) ||
1390 format == NULL ||
1391 kwlist == NULL)
1392 {
1393 PyErr_BadInternalCall();
1394 return 0;
1395 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001396
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001397 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001398
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399 retval = vgetargskeywords(args, keywords, format,
1400 kwlist, &lva, FLAG_SIZE_T);
1401 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001402}
1403
Benjamin Petersonfb886362010-04-24 18:21:17 +00001404int
1405PyArg_ValidateKeywordArguments(PyObject *kwargs)
1406{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001407 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001408 PyErr_BadInternalCall();
1409 return 0;
1410 }
1411 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1412 PyErr_SetString(PyExc_TypeError,
1413 "keyword arguments must be strings");
1414 return 0;
1415 }
1416 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001417}
1418
Christian Heimes380f7f22008-02-28 11:19:05 +00001419#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001420
Guido van Rossumaa354651996-08-19 19:32:04 +00001421static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001422vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001423 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001424{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001425 char msgbuf[512];
1426 int levels[32];
1427 const char *fname, *msg, *custom_msg, *keyword;
1428 int min = INT_MAX;
1429 int i, len, nargs, nkeywords;
1430 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001431
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 assert(args != NULL && PyTuple_Check(args));
1433 assert(keywords == NULL || PyDict_Check(keywords));
1434 assert(format != NULL);
1435 assert(kwlist != NULL);
1436 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001438 /* grab the function name or custom error msg first (mutually exclusive) */
1439 fname = strchr(format, ':');
1440 if (fname) {
1441 fname++;
1442 custom_msg = NULL;
1443 }
1444 else {
1445 custom_msg = strchr(format,';');
1446 if (custom_msg)
1447 custom_msg++;
1448 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 /* scan kwlist and get greatest possible nbr of args */
1451 for (len=0; kwlist[len]; len++)
1452 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 nargs = PyTuple_GET_SIZE(args);
1455 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1456 if (nargs + nkeywords > len) {
1457 PyErr_Format(PyExc_TypeError, "%s%s takes at most %d "
1458 "argument%s (%d given)",
1459 (fname == NULL) ? "function" : fname,
1460 (fname == NULL) ? "" : "()",
1461 len,
1462 (len == 1) ? "" : "s",
1463 nargs + nkeywords);
1464 return 0;
1465 }
Tim Petersc2f01122001-10-27 07:25:06 +00001466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1468 for (i = 0; i < len; i++) {
1469 keyword = kwlist[i];
1470 if (*format == '|') {
1471 min = i;
1472 format++;
1473 }
1474 if (IS_END_OF_FORMAT(*format)) {
1475 PyErr_Format(PyExc_RuntimeError,
1476 "More keyword list entries (%d) than "
1477 "format specifiers (%d)", len, i);
1478 return cleanreturn(0, freelist);
1479 }
1480 current_arg = NULL;
1481 if (nkeywords) {
1482 current_arg = PyDict_GetItemString(keywords, keyword);
1483 }
1484 if (current_arg) {
1485 --nkeywords;
1486 if (i < nargs) {
1487 /* arg present in tuple and in dict */
1488 PyErr_Format(PyExc_TypeError,
1489 "Argument given by name ('%s') "
1490 "and position (%d)",
1491 keyword, i+1);
1492 return cleanreturn(0, freelist);
1493 }
1494 }
1495 else if (nkeywords && PyErr_Occurred())
1496 return cleanreturn(0, freelist);
1497 else if (i < nargs)
1498 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimes380f7f22008-02-28 11:19:05 +00001499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 if (current_arg) {
1501 msg = convertitem(current_arg, &format, p_va, flags,
1502 levels, msgbuf, sizeof(msgbuf), &freelist);
1503 if (msg) {
1504 seterror(i+1, msg, levels, fname, custom_msg);
1505 return cleanreturn(0, freelist);
1506 }
1507 continue;
1508 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001510 if (i < min) {
1511 PyErr_Format(PyExc_TypeError, "Required argument "
1512 "'%s' (pos %d) not found",
1513 keyword, i+1);
1514 return cleanreturn(0, freelist);
1515 }
1516 /* current code reports success when all required args
1517 * fulfilled and no keyword args left, with no further
1518 * validation. XXX Maybe skip this in debug build ?
1519 */
1520 if (!nkeywords)
1521 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001522
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001523 /* We are into optional args, skip thru to any remaining
1524 * keyword args */
1525 msg = skipitem(&format, p_va, flags);
1526 if (msg) {
1527 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1528 format);
1529 return cleanreturn(0, freelist);
1530 }
1531 }
Tim Petersb054be42001-10-27 05:07:41 +00001532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
1534 PyErr_Format(PyExc_RuntimeError,
1535 "more argument specifiers than keyword list entries "
1536 "(remaining format:'%s')", format);
1537 return cleanreturn(0, freelist);
1538 }
Tim Petersc2f01122001-10-27 07:25:06 +00001539
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 /* make sure there are no extraneous keyword arguments */
1541 if (nkeywords > 0) {
1542 PyObject *key, *value;
1543 Py_ssize_t pos = 0;
1544 while (PyDict_Next(keywords, &pos, &key, &value)) {
1545 int match = 0;
1546 char *ks;
1547 if (!PyUnicode_Check(key)) {
1548 PyErr_SetString(PyExc_TypeError,
1549 "keywords must be strings");
1550 return cleanreturn(0, freelist);
1551 }
Victor Stinner93b55132010-05-19 00:54:06 +00001552 /* check that _PyUnicode_AsString() result is not NULL */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001553 ks = _PyUnicode_AsString(key);
Victor Stinner93b55132010-05-19 00:54:06 +00001554 if (ks != NULL) {
1555 for (i = 0; i < len; i++) {
1556 if (!strcmp(ks, kwlist[i])) {
1557 match = 1;
1558 break;
1559 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001560 }
1561 }
1562 if (!match) {
1563 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001564 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001565 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001566 key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 return cleanreturn(0, freelist);
1568 }
1569 }
1570 }
1571
1572 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001573}
1574
1575
1576static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001577skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001578{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001579 const char *format = *p_format;
1580 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001581
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001582 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001583
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 /* simple codes
1585 * The individual types (second arg of va_arg) are irrelevant */
Georg Brandl6dd14612005-09-14 19:29:53 +00001586
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001587 case 'b': /* byte -- very short int */
1588 case 'B': /* byte as bitfield */
1589 case 'h': /* short int */
1590 case 'H': /* short int as bitfield */
1591 case 'i': /* int */
1592 case 'I': /* int sized bitfield */
1593 case 'l': /* long int */
1594 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001595#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 case 'L': /* PY_LONG_LONG */
1597 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001598#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 case 'f': /* float */
1600 case 'd': /* double */
1601 case 'D': /* complex double */
1602 case 'c': /* char */
1603 case 'C': /* unicode char */
1604 {
1605 (void) va_arg(*p_va, void *);
1606 break;
1607 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 case 'n': /* Py_ssize_t */
1610 {
1611 (void) va_arg(*p_va, Py_ssize_t *);
1612 break;
1613 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617 case 'e': /* string with encoding */
1618 {
1619 (void) va_arg(*p_va, const char *);
1620 if (!(*format == 's' || *format == 't'))
1621 /* after 'e', only 's' and 't' is allowed */
1622 goto err;
1623 format++;
1624 /* explicit fallthrough to string cases */
1625 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001627 case 's': /* string */
1628 case 'z': /* string or None */
1629 case 'y': /* bytes */
1630 case 'u': /* unicode string */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001631 case 'w': /* buffer, read-write */
1632 {
1633 (void) va_arg(*p_va, char **);
1634 if (*format == '#') {
1635 if (flags & FLAG_SIZE_T)
1636 (void) va_arg(*p_va, Py_ssize_t *);
1637 else
1638 (void) va_arg(*p_va, int *);
1639 format++;
1640 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1641 format++;
1642 }
1643 break;
1644 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001645
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 /* object codes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 case 'S': /* string object */
1649 case 'Y': /* string object */
1650 case 'U': /* unicode string object */
1651 {
1652 (void) va_arg(*p_va, PyObject **);
1653 break;
1654 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001655
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001656 case 'O': /* object */
1657 {
1658 if (*format == '!') {
1659 format++;
1660 (void) va_arg(*p_va, PyTypeObject*);
1661 (void) va_arg(*p_va, PyObject **);
1662 }
1663 else if (*format == '&') {
1664 typedef int (*converter)(PyObject *, void *);
1665 (void) va_arg(*p_va, converter);
1666 (void) va_arg(*p_va, void *);
1667 format++;
1668 }
1669 else {
1670 (void) va_arg(*p_va, PyObject **);
1671 }
1672 break;
1673 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 case '(': /* bypass tuple, not handled at all previously */
1676 {
1677 char *msg;
1678 for (;;) {
1679 if (*format==')')
1680 break;
1681 if (IS_END_OF_FORMAT(*format))
1682 return "Unmatched left paren in format "
1683 "string";
1684 msg = skipitem(&format, p_va, flags);
1685 if (msg)
1686 return msg;
1687 }
1688 format++;
1689 break;
1690 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001691
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001692 case ')':
1693 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00001694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001696err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001697 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001699 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001700
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001701 *p_format = format;
1702 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001703}
Fred Drakee4616e62001-10-23 21:09:29 +00001704
1705
1706int
Martin v. Löwis76246742006-03-01 04:06:10 +00001707PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001708{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001709 Py_ssize_t i, l;
1710 PyObject **o;
1711 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001712
1713#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001714 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001715#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001716 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001717#endif
1718
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001719 assert(min >= 0);
1720 assert(min <= max);
1721 if (!PyTuple_Check(args)) {
1722 PyErr_SetString(PyExc_SystemError,
1723 "PyArg_UnpackTuple() argument list is not a tuple");
1724 return 0;
1725 }
1726 l = PyTuple_GET_SIZE(args);
1727 if (l < min) {
1728 if (name != NULL)
1729 PyErr_Format(
1730 PyExc_TypeError,
1731 "%s expected %s%zd arguments, got %zd",
1732 name, (min == max ? "" : "at least "), min, l);
1733 else
1734 PyErr_Format(
1735 PyExc_TypeError,
1736 "unpacked tuple should have %s%zd elements,"
1737 " but has %zd",
1738 (min == max ? "" : "at least "), min, l);
1739 va_end(vargs);
1740 return 0;
1741 }
1742 if (l > max) {
1743 if (name != NULL)
1744 PyErr_Format(
1745 PyExc_TypeError,
1746 "%s expected %s%zd arguments, got %zd",
1747 name, (min == max ? "" : "at most "), max, 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 most "), max, l);
1754 va_end(vargs);
1755 return 0;
1756 }
1757 for (i = 0; i < l; i++) {
1758 o = va_arg(vargs, PyObject **);
1759 *o = PyTuple_GET_ITEM(args, i);
1760 }
1761 va_end(vargs);
1762 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001763}
Georg Brandl02c42872005-08-26 06:42:30 +00001764
1765
1766/* For type constructors that don't take keyword args
1767 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001768 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001769 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001770 */
1771int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001772_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001773{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001774 if (kw == NULL)
1775 return 1;
1776 if (!PyDict_CheckExact(kw)) {
1777 PyErr_BadInternalCall();
1778 return 0;
1779 }
1780 if (PyDict_Size(kw) == 0)
1781 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001782
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001783 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1784 funcname);
1785 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001786}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001787#ifdef __cplusplus
1788};
1789#endif