blob: 487f1aa9c0d1b5bfbaaf6c4d66cc7f4be0a9d8b1 [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;
313 PyOS_snprintf(msgbuf, sizeof(msgbuf),
314 "%.200s%s takes no arguments",
315 fname==NULL ? "function" : fname,
316 fname==NULL ? "" : "()");
317 PyErr_SetString(PyExc_TypeError, msgbuf);
318 return 0;
319 }
320 else if (min == 1 && max == 1) {
321 if (args == NULL) {
322 PyOS_snprintf(msgbuf, sizeof(msgbuf),
323 "%.200s%s takes at least one argument",
324 fname==NULL ? "function" : fname,
325 fname==NULL ? "" : "()");
326 PyErr_SetString(PyExc_TypeError, msgbuf);
327 return 0;
328 }
329 msg = convertitem(args, &format, p_va, flags, levels,
330 msgbuf, sizeof(msgbuf), &freelist);
331 if (msg == NULL)
332 return cleanreturn(1, freelist);
333 seterror(levels[0], msg, levels+1, fname, message);
334 return cleanreturn(0, freelist);
335 }
336 else {
337 PyErr_SetString(PyExc_SystemError,
338 "old style getargs format uses new features");
339 return 0;
340 }
341 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000342
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 if (!PyTuple_Check(args)) {
344 PyErr_SetString(PyExc_SystemError,
345 "new style getargs format but argument is not a tuple");
346 return 0;
347 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000350
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000351 if (len < min || max < len) {
352 if (message == NULL) {
353 PyOS_snprintf(msgbuf, sizeof(msgbuf),
354 "%.150s%s takes %s %d argument%s "
355 "(%ld given)",
356 fname==NULL ? "function" : fname,
357 fname==NULL ? "" : "()",
358 min==max ? "exactly"
359 : len < min ? "at least" : "at most",
360 len < min ? min : max,
361 (len < min ? min : max) == 1 ? "" : "s",
362 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
363 message = msgbuf;
364 }
365 PyErr_SetString(PyExc_TypeError, message);
366 return 0;
367 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 for (i = 0; i < len; i++) {
370 if (*format == '|')
371 format++;
372 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
373 flags, levels, msgbuf,
374 sizeof(msgbuf), &freelist);
375 if (msg) {
376 seterror(i+1, msg, levels, fname, msg);
377 return cleanreturn(0, freelist);
378 }
379 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000380
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000381 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
382 *format != '(' &&
383 *format != '|' && *format != ':' && *format != ';') {
384 PyErr_Format(PyExc_SystemError,
385 "bad format string: %.200s", formatsave);
386 return cleanreturn(0, freelist);
387 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000390}
391
392
393
394static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000395seterror(int iarg, const char *msg, int *levels, const char *fname,
396 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000397{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000398 char buf[512];
399 int i;
400 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000401
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000402 if (PyErr_Occurred())
403 return;
404 else if (message == NULL) {
405 if (fname != NULL) {
406 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
407 p += strlen(p);
408 }
409 if (iarg != 0) {
410 PyOS_snprintf(p, sizeof(buf) - (p - buf),
411 "argument %d", iarg);
412 i = 0;
413 p += strlen(p);
414 while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
415 PyOS_snprintf(p, sizeof(buf) - (p - buf),
416 ", item %d", levels[i]-1);
417 p += strlen(p);
418 i++;
419 }
420 }
421 else {
422 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
423 p += strlen(p);
424 }
425 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
426 message = buf;
427 }
428 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000429}
430
431
432/* Convert a tuple argument.
433 On entry, *p_format points to the character _after_ the opening '('.
434 On successful exit, *p_format points to the closing ')'.
435 If successful:
436 *p_format and *p_va are updated,
437 *levels and *msgbuf are untouched,
438 and NULL is returned.
439 If the argument is invalid:
440 *p_format is unchanged,
441 *p_va is undefined,
442 *levels is a 0-terminated list of item numbers,
443 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 "must be <typename1>, not <typename2>", where:
445 <typename1> is the name of the expected type, and
446 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000447 and msgbuf is returned.
448*/
449
450static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000451converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000452 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000453 PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000454{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000455 int level = 0;
456 int n = 0;
457 const char *format = *p_format;
458 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000460 for (;;) {
461 int c = *format++;
462 if (c == '(') {
463 if (level == 0)
464 n++;
465 level++;
466 }
467 else if (c == ')') {
468 if (level == 0)
469 break;
470 level--;
471 }
472 else if (c == ':' || c == ';' || c == '\0')
473 break;
474 else if (level == 0 && isalpha(Py_CHARMASK(c)))
475 n++;
476 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000478 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
479 levels[0] = 0;
480 PyOS_snprintf(msgbuf, bufsize,
481 toplevel ? "expected %d arguments, not %.50s" :
482 "must be %d-item sequence, not %.50s",
483 n,
484 arg == Py_None ? "None" : arg->ob_type->tp_name);
485 return msgbuf;
486 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000488 if ((i = PySequence_Size(arg)) != n) {
489 levels[0] = 0;
490 PyOS_snprintf(msgbuf, bufsize,
491 toplevel ? "expected %d arguments, not %d" :
492 "must be sequence of length %d, not %d",
493 n, i);
494 return msgbuf;
495 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000496
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000497 format = *p_format;
498 for (i = 0; i < n; i++) {
499 char *msg;
500 PyObject *item;
501 item = PySequence_GetItem(arg, i);
502 if (item == NULL) {
503 PyErr_Clear();
504 levels[0] = i+1;
505 levels[1] = 0;
506 strncpy(msgbuf, "is not retrievable", bufsize);
507 return msgbuf;
508 }
509 msg = convertitem(item, &format, p_va, flags, levels+1,
510 msgbuf, bufsize, freelist);
511 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
512 Py_XDECREF(item);
513 if (msg != NULL) {
514 levels[0] = i+1;
515 return msg;
516 }
517 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000518
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000519 *p_format = format;
520 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000521}
522
523
524/* Convert a single item. */
525
526static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000527convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
528 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000529{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 char *msg;
531 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 if (*format == '(' /* ')' */) {
534 format++;
535 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
536 bufsize, 0, freelist);
537 if (msg == NULL)
538 format++;
539 }
540 else {
541 msg = convertsimple(arg, &format, p_va, flags,
542 msgbuf, bufsize, freelist);
543 if (msg != NULL)
544 levels[0] = 0;
545 }
546 if (msg == NULL)
547 *p_format = format;
548 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000549}
550
551
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000552
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000553#define UNICODE_DEFAULT_ENCODING(arg) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 _PyUnicode_AsDefaultEncodedString(arg, NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000555
556/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000557
558static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000559converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000560{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000561 assert(expected != NULL);
562 assert(arg != NULL);
563 PyOS_snprintf(msgbuf, bufsize,
564 "must be %.50s, not %.50s", expected,
565 arg == Py_None ? "None" : arg->ob_type->tp_name);
566 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000567}
568
569#define CONV_UNICODE "(unicode conversion error)"
570
Guido van Rossum45aecf42006-03-15 04:58:47 +0000571/* Explicitly check for float arguments when integers are expected.
572 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000573static int
574float_argument_error(PyObject *arg)
575{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000576 if (PyFloat_Check(arg)) {
577 PyErr_SetString(PyExc_TypeError,
578 "integer argument expected, got float" );
579 return 1;
580 }
581 else
582 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000583}
584
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000585/* Convert a non-tuple argument. Return NULL if conversion went OK,
586 or a string with a message describing the failure. The message is
587 formatted as "must be <desired type>, not <actual type>".
588 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000589 Don't call if a tuple is expected.
590
591 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000592*/
593
594static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000595convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000596 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000597{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 /* For # codes */
599#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
600 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
601 else q=va_arg(*p_va, int*);
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000602#define STORE_SIZE(s) \
603 if (flags & FLAG_SIZE_T) \
604 *q2=s; \
605 else { \
606 if (INT_MAX < s) { \
607 PyErr_SetString(PyExc_OverflowError, \
608 "size does not fit in an int"); \
609 return converterr("", arg, msgbuf, bufsize); \
610 } \
611 *q=s; \
612 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000613#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000615 const char *format = *p_format;
616 char c = *format++;
617 PyObject *uarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000620
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000621 case 'b': { /* unsigned byte -- very short int */
622 char *p = va_arg(*p_va, char *);
623 long ival;
624 if (float_argument_error(arg))
625 return converterr("integer<b>", arg, msgbuf, bufsize);
626 ival = PyLong_AsLong(arg);
627 if (ival == -1 && PyErr_Occurred())
628 return converterr("integer<b>", arg, msgbuf, bufsize);
629 else if (ival < 0) {
630 PyErr_SetString(PyExc_OverflowError,
631 "unsigned byte integer is less than minimum");
632 return converterr("integer<b>", arg, msgbuf, bufsize);
633 }
634 else if (ival > UCHAR_MAX) {
635 PyErr_SetString(PyExc_OverflowError,
636 "unsigned byte integer is greater than maximum");
637 return converterr("integer<b>", arg, msgbuf, bufsize);
638 }
639 else
640 *p = (unsigned char) ival;
641 break;
642 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000643
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000644 case 'B': {/* byte sized bitfield - both signed and unsigned
645 values allowed */
646 char *p = va_arg(*p_va, char *);
647 long ival;
648 if (float_argument_error(arg))
649 return converterr("integer<B>", arg, msgbuf, bufsize);
650 ival = PyLong_AsUnsignedLongMask(arg);
651 if (ival == -1 && PyErr_Occurred())
652 return converterr("integer<B>", arg, msgbuf, bufsize);
653 else
654 *p = (unsigned char) ival;
655 break;
656 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000658 case 'h': {/* signed short int */
659 short *p = va_arg(*p_va, short *);
660 long ival;
661 if (float_argument_error(arg))
662 return converterr("integer<h>", arg, msgbuf, bufsize);
663 ival = PyLong_AsLong(arg);
664 if (ival == -1 && PyErr_Occurred())
665 return converterr("integer<h>", arg, msgbuf, bufsize);
666 else if (ival < SHRT_MIN) {
667 PyErr_SetString(PyExc_OverflowError,
668 "signed short integer is less than minimum");
669 return converterr("integer<h>", arg, msgbuf, bufsize);
670 }
671 else if (ival > SHRT_MAX) {
672 PyErr_SetString(PyExc_OverflowError,
673 "signed short integer is greater than maximum");
674 return converterr("integer<h>", arg, msgbuf, bufsize);
675 }
676 else
677 *p = (short) ival;
678 break;
679 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000680
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000681 case 'H': { /* short int sized bitfield, both signed and
682 unsigned allowed */
683 unsigned short *p = va_arg(*p_va, unsigned short *);
684 long ival;
685 if (float_argument_error(arg))
686 return converterr("integer<H>", arg, msgbuf, bufsize);
687 ival = PyLong_AsUnsignedLongMask(arg);
688 if (ival == -1 && PyErr_Occurred())
689 return converterr("integer<H>", arg, msgbuf, bufsize);
690 else
691 *p = (unsigned short) ival;
692 break;
693 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000695 case 'i': {/* signed int */
696 int *p = va_arg(*p_va, int *);
697 long ival;
698 if (float_argument_error(arg))
699 return converterr("integer<i>", arg, msgbuf, bufsize);
700 ival = PyLong_AsLong(arg);
701 if (ival == -1 && PyErr_Occurred())
702 return converterr("integer<i>", arg, msgbuf, bufsize);
703 else if (ival > INT_MAX) {
704 PyErr_SetString(PyExc_OverflowError,
705 "signed integer is greater than maximum");
706 return converterr("integer<i>", arg, msgbuf, bufsize);
707 }
708 else if (ival < INT_MIN) {
709 PyErr_SetString(PyExc_OverflowError,
710 "signed integer is less than minimum");
711 return converterr("integer<i>", arg, msgbuf, bufsize);
712 }
713 else
714 *p = ival;
715 break;
716 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000717
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 case 'I': { /* int sized bitfield, both signed and
719 unsigned allowed */
720 unsigned int *p = va_arg(*p_va, unsigned int *);
721 unsigned int ival;
722 if (float_argument_error(arg))
723 return converterr("integer<I>", arg, msgbuf, bufsize);
724 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
725 if (ival == (unsigned int)-1 && PyErr_Occurred())
726 return converterr("integer<I>", arg, msgbuf, bufsize);
727 else
728 *p = ival;
729 break;
730 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000731
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000732 case 'n': /* Py_ssize_t */
733 {
734 PyObject *iobj;
735 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
736 Py_ssize_t ival = -1;
737 if (float_argument_error(arg))
738 return converterr("integer<n>", arg, msgbuf, bufsize);
739 iobj = PyNumber_Index(arg);
740 if (iobj != NULL) {
741 ival = PyLong_AsSsize_t(iobj);
742 Py_DECREF(iobj);
743 }
744 if (ival == -1 && PyErr_Occurred())
745 return converterr("integer<n>", arg, msgbuf, bufsize);
746 *p = ival;
747 break;
748 }
749 case 'l': {/* long int */
750 long *p = va_arg(*p_va, long *);
751 long ival;
752 if (float_argument_error(arg))
753 return converterr("integer<l>", arg, msgbuf, bufsize);
754 ival = PyLong_AsLong(arg);
755 if (ival == -1 && PyErr_Occurred())
756 return converterr("integer<l>", arg, msgbuf, bufsize);
757 else
758 *p = ival;
759 break;
760 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000761
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000762 case 'k': { /* long sized bitfield */
763 unsigned long *p = va_arg(*p_va, unsigned long *);
764 unsigned long ival;
765 if (PyLong_Check(arg))
766 ival = PyLong_AsUnsignedLongMask(arg);
767 else
768 return converterr("integer<k>", arg, msgbuf, bufsize);
769 *p = ival;
770 break;
771 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000772
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000773#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000774 case 'L': {/* PY_LONG_LONG */
775 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
776 PY_LONG_LONG ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000777 if (float_argument_error(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 return converterr("long<L>", arg, msgbuf, bufsize);
779 ival = PyLong_AsLongLong(arg);
Mark Dickinsonc7301312010-06-10 16:05:10 +0000780 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred())
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 return converterr("long<L>", arg, msgbuf, bufsize);
Mark Dickinsonc7301312010-06-10 16:05:10 +0000782 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000783 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000784 break;
785 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000786
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 case 'K': { /* long long sized bitfield */
788 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
789 unsigned PY_LONG_LONG ival;
790 if (PyLong_Check(arg))
791 ival = PyLong_AsUnsignedLongLongMask(arg);
792 else
793 return converterr("integer<K>", arg, msgbuf, bufsize);
794 *p = ival;
795 break;
796 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000797#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000798
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000799 case 'f': {/* float */
800 float *p = va_arg(*p_va, float *);
801 double dval = PyFloat_AsDouble(arg);
802 if (PyErr_Occurred())
803 return converterr("float<f>", arg, msgbuf, bufsize);
804 else
805 *p = (float) dval;
806 break;
807 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000808
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000809 case 'd': {/* double */
810 double *p = va_arg(*p_va, double *);
811 double dval = PyFloat_AsDouble(arg);
812 if (PyErr_Occurred())
813 return converterr("float<d>", arg, msgbuf, bufsize);
814 else
815 *p = dval;
816 break;
817 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000818
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 case 'D': {/* complex double */
820 Py_complex *p = va_arg(*p_va, Py_complex *);
821 Py_complex cval;
822 cval = PyComplex_AsCComplex(arg);
823 if (PyErr_Occurred())
824 return converterr("complex<D>", arg, msgbuf, bufsize);
825 else
826 *p = cval;
827 break;
828 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000829
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 case 'c': {/* char */
831 char *p = va_arg(*p_va, char *);
832 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
833 *p = PyBytes_AS_STRING(arg)[0];
834 else
835 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
836 break;
837 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000839 case 'C': {/* unicode char */
840 int *p = va_arg(*p_va, int *);
841 if (PyUnicode_Check(arg) &&
842 PyUnicode_GET_SIZE(arg) == 1)
843 *p = PyUnicode_AS_UNICODE(arg)[0];
844 else
845 return converterr("a unicode character", arg, msgbuf, bufsize);
846 break;
847 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000848
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000849 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000850 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000851
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 case 'y': {/* any buffer-like object, but not PyUnicode */
853 void **p = (void **)va_arg(*p_va, char **);
854 char *buf;
855 Py_ssize_t count;
856 if (*format == '*') {
857 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
858 return converterr(buf, arg, msgbuf, bufsize);
859 format++;
Victor Stinnera093d0d2011-01-04 11:16:48 +0000860 if (addcleanup(p, freelist, 1)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 return converterr(
862 "(cleanup problem)",
863 arg, msgbuf, bufsize);
864 }
865 break;
866 }
867 count = convertbuffer(arg, p, &buf);
868 if (count < 0)
869 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000870 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000871 FETCH_SIZE;
872 STORE_SIZE(count);
873 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000874 } else {
875 if (strlen(*p) != count)
876 return converterr(
877 "bytes without null bytes",
878 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000879 }
880 break;
881 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000882
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000883 case 's': /* text string */
884 case 'z': /* text string or None */
885 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000886 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000887 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000888 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000889
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000890 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000891 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
892 else if (PyUnicode_Check(arg)) {
893 uarg = UNICODE_DEFAULT_ENCODING(arg);
894 if (uarg == NULL)
895 return converterr(CONV_UNICODE,
896 arg, msgbuf, bufsize);
897 PyBuffer_FillInfo(p, arg,
898 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
899 1, 0);
900 }
901 else { /* any buffer-like object */
902 char *buf;
903 if (getbuffer(arg, p, &buf) < 0)
904 return converterr(buf, arg, msgbuf, bufsize);
905 }
Victor Stinnera093d0d2011-01-04 11:16:48 +0000906 if (addcleanup(p, freelist, 1)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 return converterr(
908 "(cleanup problem)",
909 arg, msgbuf, bufsize);
910 }
911 format++;
912 } else if (*format == '#') { /* any buffer-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000913 /* "s#" or "z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000914 void **p = (void **)va_arg(*p_va, char **);
915 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000916
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000917 if (c == 'z' && arg == Py_None) {
918 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 STORE_SIZE(0);
920 }
921 else if (PyUnicode_Check(arg)) {
922 uarg = UNICODE_DEFAULT_ENCODING(arg);
923 if (uarg == NULL)
924 return converterr(CONV_UNICODE,
925 arg, msgbuf, bufsize);
926 *p = PyBytes_AS_STRING(uarg);
927 STORE_SIZE(PyBytes_GET_SIZE(uarg));
928 }
929 else { /* any buffer-like object */
930 /* XXX Really? */
931 char *buf;
932 Py_ssize_t count = convertbuffer(arg, p, &buf);
933 if (count < 0)
934 return converterr(buf, arg, msgbuf, bufsize);
935 STORE_SIZE(count);
936 }
937 format++;
938 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000939 /* "s" or "z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000940 char **p = va_arg(*p_va, char **);
941 uarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000942
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000943 if (c == 'z' && arg == Py_None)
944 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000945 else if (PyUnicode_Check(arg)) {
946 uarg = UNICODE_DEFAULT_ENCODING(arg);
947 if (uarg == NULL)
948 return converterr(CONV_UNICODE,
949 arg, msgbuf, bufsize);
950 *p = PyBytes_AS_STRING(uarg);
951 }
952 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000953 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000954 arg, msgbuf, bufsize);
Victor Stinner43fb0092010-05-29 00:13:06 +0000955 if (*p != NULL && uarg != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 (Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
957 return converterr(
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000958 c == 'z' ? "str without null bytes or None"
959 : "str without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 arg, msgbuf, bufsize);
961 }
962 break;
963 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000964
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000965 case 'u': /* raw unicode buffer (Py_UNICODE *) */
966 case 'Z': /* raw unicode buffer or None */
967 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 if (*format == '#') { /* any buffer-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000969 /* "s#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
971 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000972
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000973 if (c == 'Z' && arg == Py_None) {
974 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000975 STORE_SIZE(0);
976 }
977 else if (PyUnicode_Check(arg)) {
978 *p = PyUnicode_AS_UNICODE(arg);
979 STORE_SIZE(PyUnicode_GET_SIZE(arg));
980 }
Victor Stinner5216e6d2010-06-08 21:45:51 +0000981 else
982 return converterr("str or None", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000983 format++;
984 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000985 /* "s" or "Z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000986 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000987
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000988 if (c == 'Z' && arg == Py_None)
989 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000990 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000991 *p = PyUnicode_AS_UNICODE(arg);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000992 if (Py_UNICODE_strlen(*p) != PyUnicode_GET_SIZE(arg))
993 return converterr(
994 "str without null character or None",
995 arg, msgbuf, bufsize);
996 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000997 return converterr(c == 'Z' ? "str or None" : "str",
998 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999 }
1000 break;
1001 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001002
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001003 case 'e': {/* encoded string */
1004 char **buffer;
1005 const char *encoding;
1006 PyObject *s;
1007 int recode_strings;
1008 Py_ssize_t size;
1009 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001010
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001011 /* Get 'e' parameter: the encoding name */
1012 encoding = (const char *)va_arg(*p_va, const char *);
1013 if (encoding == NULL)
1014 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001015
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001016 /* Get output buffer parameter:
1017 's' (recode all objects via Unicode) or
1018 't' (only recode non-string objects)
1019 */
1020 if (*format == 's')
1021 recode_strings = 1;
1022 else if (*format == 't')
1023 recode_strings = 0;
1024 else
1025 return converterr(
1026 "(unknown parser marker combination)",
1027 arg, msgbuf, bufsize);
1028 buffer = (char **)va_arg(*p_va, char **);
1029 format++;
1030 if (buffer == NULL)
1031 return converterr("(buffer is NULL)",
1032 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001033
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001034 /* Encode object */
1035 if (!recode_strings &&
1036 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1037 s = arg;
1038 Py_INCREF(s);
1039 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1040 return converterr("(AsCharBuffer failed)",
1041 arg, msgbuf, bufsize);
1042 }
1043 else {
1044 PyObject *u;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 /* Convert object to Unicode */
1047 u = PyUnicode_FromObject(arg);
1048 if (u == NULL)
1049 return converterr(
1050 "string or unicode or text buffer",
1051 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001052
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 /* Encode object; use default error handling */
1054 s = PyUnicode_AsEncodedString(u,
1055 encoding,
1056 NULL);
1057 Py_DECREF(u);
1058 if (s == NULL)
1059 return converterr("(encoding failed)",
1060 arg, msgbuf, bufsize);
1061 if (!PyBytes_Check(s)) {
1062 Py_DECREF(s);
1063 return converterr(
1064 "(encoder failed to return bytes)",
1065 arg, msgbuf, bufsize);
1066 }
1067 size = PyBytes_GET_SIZE(s);
1068 ptr = PyBytes_AS_STRING(s);
1069 if (ptr == NULL)
1070 ptr = "";
1071 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001072
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001073 /* Write output; output is guaranteed to be 0-terminated */
1074 if (*format == '#') {
1075 /* Using buffer length parameter '#':
1076
1077 - if *buffer is NULL, a new buffer of the
1078 needed size is allocated and the data
1079 copied into it; *buffer is updated to point
1080 to the new buffer; the caller is
1081 responsible for PyMem_Free()ing it after
1082 usage
1083
1084 - if *buffer is not NULL, the data is
1085 copied to *buffer; *buffer_len has to be
1086 set to the size of the buffer on input;
1087 buffer overflow is signalled with an error;
1088 buffer has to provide enough room for the
1089 encoded string plus the trailing 0-byte
1090
1091 - in both cases, *buffer_len is updated to
1092 the size of the buffer /excluding/ the
1093 trailing 0-byte
1094
1095 */
1096 FETCH_SIZE;
1097
1098 format++;
1099 if (q == NULL && q2 == NULL) {
1100 Py_DECREF(s);
1101 return converterr(
1102 "(buffer_len is NULL)",
1103 arg, msgbuf, bufsize);
1104 }
1105 if (*buffer == NULL) {
1106 *buffer = PyMem_NEW(char, size + 1);
1107 if (*buffer == NULL) {
1108 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001109 PyErr_NoMemory();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001110 return converterr(
1111 "(memory error)",
1112 arg, msgbuf, bufsize);
1113 }
Victor Stinnera093d0d2011-01-04 11:16:48 +00001114 if (addcleanup(*buffer, freelist, 0)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 Py_DECREF(s);
1116 return converterr(
1117 "(cleanup problem)",
1118 arg, msgbuf, bufsize);
1119 }
1120 } else {
1121 if (size + 1 > BUFFER_LEN) {
1122 Py_DECREF(s);
1123 return converterr(
1124 "(buffer overflow)",
1125 arg, msgbuf, bufsize);
1126 }
1127 }
1128 memcpy(*buffer, ptr, size+1);
1129 STORE_SIZE(size);
1130 } else {
1131 /* Using a 0-terminated buffer:
1132
1133 - the encoded string has to be 0-terminated
1134 for this variant to work; if it is not, an
1135 error raised
1136
1137 - a new buffer of the needed size is
1138 allocated and the data copied into it;
1139 *buffer is updated to point to the new
1140 buffer; the caller is responsible for
1141 PyMem_Free()ing it after usage
1142
1143 */
1144 if ((Py_ssize_t)strlen(ptr) != size) {
1145 Py_DECREF(s);
1146 return converterr(
1147 "encoded string without NULL bytes",
1148 arg, msgbuf, bufsize);
1149 }
1150 *buffer = PyMem_NEW(char, size + 1);
1151 if (*buffer == NULL) {
1152 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001153 PyErr_NoMemory();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001154 return converterr("(memory error)",
1155 arg, msgbuf, bufsize);
1156 }
Victor Stinnera093d0d2011-01-04 11:16:48 +00001157 if (addcleanup(*buffer, freelist, 0)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001158 Py_DECREF(s);
1159 return converterr("(cleanup problem)",
1160 arg, msgbuf, bufsize);
1161 }
1162 memcpy(*buffer, ptr, size+1);
1163 }
1164 Py_DECREF(s);
1165 break;
1166 }
1167
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 case 'S': { /* PyBytes object */
1169 PyObject **p = va_arg(*p_va, PyObject **);
1170 if (PyBytes_Check(arg))
1171 *p = arg;
1172 else
1173 return converterr("bytes", arg, msgbuf, bufsize);
1174 break;
1175 }
1176
1177 case 'Y': { /* PyByteArray object */
1178 PyObject **p = va_arg(*p_va, PyObject **);
1179 if (PyByteArray_Check(arg))
1180 *p = arg;
1181 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001182 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001183 break;
1184 }
1185
1186 case 'U': { /* PyUnicode object */
1187 PyObject **p = va_arg(*p_va, PyObject **);
1188 if (PyUnicode_Check(arg))
1189 *p = arg;
1190 else
1191 return converterr("str", arg, msgbuf, bufsize);
1192 break;
1193 }
1194
1195 case 'O': { /* object */
1196 PyTypeObject *type;
1197 PyObject **p;
1198 if (*format == '!') {
1199 type = va_arg(*p_va, PyTypeObject*);
1200 p = va_arg(*p_va, PyObject **);
1201 format++;
1202 if (PyType_IsSubtype(arg->ob_type, type))
1203 *p = arg;
1204 else
1205 return converterr(type->tp_name, arg, msgbuf, bufsize);
1206
1207 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001208 else if (*format == '&') {
1209 typedef int (*converter)(PyObject *, void *);
1210 converter convert = va_arg(*p_va, converter);
1211 void *addr = va_arg(*p_va, void *);
1212 int res;
1213 format++;
1214 if (! (res = (*convert)(arg, addr)))
1215 return converterr("(unspecified)",
1216 arg, msgbuf, bufsize);
1217 if (res == Py_CLEANUP_SUPPORTED &&
1218 addcleanup_convert(addr, freelist, convert) == -1)
1219 return converterr("(cleanup problem)",
1220 arg, msgbuf, bufsize);
1221 }
1222 else {
1223 p = va_arg(*p_va, PyObject **);
1224 *p = arg;
1225 }
1226 break;
1227 }
1228
1229
Victor Stinner25e8ec42010-06-25 00:02:38 +00001230 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001231 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001232
Victor Stinner25e8ec42010-06-25 00:02:38 +00001233 if (*format != '*')
1234 return converterr(
1235 "invalid use of 'w' format character",
1236 arg, msgbuf, bufsize);
1237 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238
Victor Stinner25e8ec42010-06-25 00:02:38 +00001239 /* Caller is interested in Py_buffer, and the object
1240 supports it directly. */
1241 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1242 PyErr_Clear();
1243 return converterr("read-write buffer", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001244 }
Victor Stinner8182b712010-07-28 00:40:58 +00001245 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1246 PyBuffer_Release((Py_buffer*)p);
1247 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1248 }
Victor Stinnera093d0d2011-01-04 11:16:48 +00001249 if (addcleanup(p, freelist, 1)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001250 return converterr(
1251 "(cleanup problem)",
1252 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001254 break;
1255 }
1256
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001257 default:
1258 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
1259
1260 }
1261
1262 *p_format = format;
1263 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001264}
Guido van Rossumaa354651996-08-19 19:32:04 +00001265
Martin v. Löwis18e16552006-02-15 17:27:45 +00001266static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001267convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001268{
Victor Stinner5cb62392010-06-06 20:27:51 +00001269 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001270 Py_ssize_t count;
1271 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001272
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 *errmsg = NULL;
1274 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001275 if (pb != NULL && pb->bf_releasebuffer != NULL) {
1276 *errmsg = "read-only pinned buffer";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001277 return -1;
1278 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001279
Victor Stinner8182b712010-07-28 00:40:58 +00001280 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001281 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001282 count = view.len;
1283 *p = view.buf;
1284 PyBuffer_Release(&view);
1285 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001286}
Guido van Rossumaa354651996-08-19 19:32:04 +00001287
Martin v. Löwis423be952008-08-13 15:53:07 +00001288static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001289getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001290{
Victor Stinner8182b712010-07-28 00:40:58 +00001291 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001292 *errmsg = "bytes or buffer";
1293 return -1;
1294 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001295 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001296 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001297 *errmsg = "contiguous buffer";
1298 return -1;
1299 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001300 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001301}
1302
Guido van Rossumaa354651996-08-19 19:32:04 +00001303/* Support for keyword arguments donated by
1304 Geoff Philbrick <philbric@delphi.hks.com> */
1305
Tim Petersf8cd3e82001-10-27 04:26:57 +00001306/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001307int
1308PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001309 PyObject *keywords,
1310 const char *format,
1311 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001312{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001313 int retval;
1314 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001315
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 if ((args == NULL || !PyTuple_Check(args)) ||
1317 (keywords != NULL && !PyDict_Check(keywords)) ||
1318 format == NULL ||
1319 kwlist == NULL)
1320 {
1321 PyErr_BadInternalCall();
1322 return 0;
1323 }
Tim Peters45772cd2001-10-27 03:58:40 +00001324
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001325 va_start(va, kwlist);
1326 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1327 va_end(va);
1328 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001329}
1330
1331int
1332_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001333 PyObject *keywords,
1334 const char *format,
1335 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001336{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 int retval;
1338 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001340 if ((args == NULL || !PyTuple_Check(args)) ||
1341 (keywords != NULL && !PyDict_Check(keywords)) ||
1342 format == NULL ||
1343 kwlist == NULL)
1344 {
1345 PyErr_BadInternalCall();
1346 return 0;
1347 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 va_start(va, kwlist);
1350 retval = vgetargskeywords(args, keywords, format,
1351 kwlist, &va, FLAG_SIZE_T);
1352 va_end(va);
1353 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001354}
1355
1356
Brett Cannon711e7d92004-07-10 22:20:32 +00001357int
1358PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001359 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001360 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001361 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001362{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001363 int retval;
1364 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001365
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001366 if ((args == NULL || !PyTuple_Check(args)) ||
1367 (keywords != NULL && !PyDict_Check(keywords)) ||
1368 format == NULL ||
1369 kwlist == NULL)
1370 {
1371 PyErr_BadInternalCall();
1372 return 0;
1373 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001374
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001375 Py_VA_COPY(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001376
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1378 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001379}
1380
1381int
1382_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001383 PyObject *keywords,
1384 const char *format,
1385 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001386{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 int retval;
1388 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 if ((args == NULL || !PyTuple_Check(args)) ||
1391 (keywords != NULL && !PyDict_Check(keywords)) ||
1392 format == NULL ||
1393 kwlist == NULL)
1394 {
1395 PyErr_BadInternalCall();
1396 return 0;
1397 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001398
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001399 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001400
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001401 retval = vgetargskeywords(args, keywords, format,
1402 kwlist, &lva, FLAG_SIZE_T);
1403 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001404}
1405
Benjamin Petersonfb886362010-04-24 18:21:17 +00001406int
1407PyArg_ValidateKeywordArguments(PyObject *kwargs)
1408{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001409 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001410 PyErr_BadInternalCall();
1411 return 0;
1412 }
1413 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1414 PyErr_SetString(PyExc_TypeError,
1415 "keyword arguments must be strings");
1416 return 0;
1417 }
1418 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001419}
1420
Christian Heimes380f7f22008-02-28 11:19:05 +00001421#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001422
Guido van Rossumaa354651996-08-19 19:32:04 +00001423static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001424vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001425 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001426{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 char msgbuf[512];
1428 int levels[32];
1429 const char *fname, *msg, *custom_msg, *keyword;
1430 int min = INT_MAX;
1431 int i, len, nargs, nkeywords;
1432 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 assert(args != NULL && PyTuple_Check(args));
1435 assert(keywords == NULL || PyDict_Check(keywords));
1436 assert(format != NULL);
1437 assert(kwlist != NULL);
1438 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001439
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001440 /* grab the function name or custom error msg first (mutually exclusive) */
1441 fname = strchr(format, ':');
1442 if (fname) {
1443 fname++;
1444 custom_msg = NULL;
1445 }
1446 else {
1447 custom_msg = strchr(format,';');
1448 if (custom_msg)
1449 custom_msg++;
1450 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001451
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001452 /* scan kwlist and get greatest possible nbr of args */
1453 for (len=0; kwlist[len]; len++)
1454 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 nargs = PyTuple_GET_SIZE(args);
1457 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1458 if (nargs + nkeywords > len) {
1459 PyErr_Format(PyExc_TypeError, "%s%s takes at most %d "
1460 "argument%s (%d given)",
1461 (fname == NULL) ? "function" : fname,
1462 (fname == NULL) ? "" : "()",
1463 len,
1464 (len == 1) ? "" : "s",
1465 nargs + nkeywords);
1466 return 0;
1467 }
Tim Petersc2f01122001-10-27 07:25:06 +00001468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1470 for (i = 0; i < len; i++) {
1471 keyword = kwlist[i];
1472 if (*format == '|') {
1473 min = i;
1474 format++;
1475 }
1476 if (IS_END_OF_FORMAT(*format)) {
1477 PyErr_Format(PyExc_RuntimeError,
1478 "More keyword list entries (%d) than "
1479 "format specifiers (%d)", len, i);
1480 return cleanreturn(0, freelist);
1481 }
1482 current_arg = NULL;
1483 if (nkeywords) {
1484 current_arg = PyDict_GetItemString(keywords, keyword);
1485 }
1486 if (current_arg) {
1487 --nkeywords;
1488 if (i < nargs) {
1489 /* arg present in tuple and in dict */
1490 PyErr_Format(PyExc_TypeError,
1491 "Argument given by name ('%s') "
1492 "and position (%d)",
1493 keyword, i+1);
1494 return cleanreturn(0, freelist);
1495 }
1496 }
1497 else if (nkeywords && PyErr_Occurred())
1498 return cleanreturn(0, freelist);
1499 else if (i < nargs)
1500 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimes380f7f22008-02-28 11:19:05 +00001501
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001502 if (current_arg) {
1503 msg = convertitem(current_arg, &format, p_va, flags,
1504 levels, msgbuf, sizeof(msgbuf), &freelist);
1505 if (msg) {
1506 seterror(i+1, msg, levels, fname, custom_msg);
1507 return cleanreturn(0, freelist);
1508 }
1509 continue;
1510 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001511
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001512 if (i < min) {
1513 PyErr_Format(PyExc_TypeError, "Required argument "
1514 "'%s' (pos %d) not found",
1515 keyword, i+1);
1516 return cleanreturn(0, freelist);
1517 }
1518 /* current code reports success when all required args
1519 * fulfilled and no keyword args left, with no further
1520 * validation. XXX Maybe skip this in debug build ?
1521 */
1522 if (!nkeywords)
1523 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 /* We are into optional args, skip thru to any remaining
1526 * keyword args */
1527 msg = skipitem(&format, p_va, flags);
1528 if (msg) {
1529 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1530 format);
1531 return cleanreturn(0, freelist);
1532 }
1533 }
Tim Petersb054be42001-10-27 05:07:41 +00001534
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001535 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
1536 PyErr_Format(PyExc_RuntimeError,
1537 "more argument specifiers than keyword list entries "
1538 "(remaining format:'%s')", format);
1539 return cleanreturn(0, freelist);
1540 }
Tim Petersc2f01122001-10-27 07:25:06 +00001541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 /* make sure there are no extraneous keyword arguments */
1543 if (nkeywords > 0) {
1544 PyObject *key, *value;
1545 Py_ssize_t pos = 0;
1546 while (PyDict_Next(keywords, &pos, &key, &value)) {
1547 int match = 0;
1548 char *ks;
1549 if (!PyUnicode_Check(key)) {
1550 PyErr_SetString(PyExc_TypeError,
1551 "keywords must be strings");
1552 return cleanreturn(0, freelist);
1553 }
Victor Stinner93b55132010-05-19 00:54:06 +00001554 /* check that _PyUnicode_AsString() result is not NULL */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001555 ks = _PyUnicode_AsString(key);
Victor Stinner93b55132010-05-19 00:54:06 +00001556 if (ks != NULL) {
1557 for (i = 0; i < len; i++) {
1558 if (!strcmp(ks, kwlist[i])) {
1559 match = 1;
1560 break;
1561 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 }
1563 }
1564 if (!match) {
1565 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001566 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001568 key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001569 return cleanreturn(0, freelist);
1570 }
1571 }
1572 }
1573
1574 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001575}
1576
1577
1578static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001579skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001580{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 const char *format = *p_format;
1582 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001583
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 /* simple codes
1587 * The individual types (second arg of va_arg) are irrelevant */
Georg Brandl6dd14612005-09-14 19:29:53 +00001588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 case 'b': /* byte -- very short int */
1590 case 'B': /* byte as bitfield */
1591 case 'h': /* short int */
1592 case 'H': /* short int as bitfield */
1593 case 'i': /* int */
1594 case 'I': /* int sized bitfield */
1595 case 'l': /* long int */
1596 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001597#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 case 'L': /* PY_LONG_LONG */
1599 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001600#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001601 case 'f': /* float */
1602 case 'd': /* double */
1603 case 'D': /* complex double */
1604 case 'c': /* char */
1605 case 'C': /* unicode char */
1606 {
1607 (void) va_arg(*p_va, void *);
1608 break;
1609 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 case 'n': /* Py_ssize_t */
1612 {
1613 (void) va_arg(*p_va, Py_ssize_t *);
1614 break;
1615 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001619 case 'e': /* string with encoding */
1620 {
1621 (void) va_arg(*p_va, const char *);
1622 if (!(*format == 's' || *format == 't'))
1623 /* after 'e', only 's' and 't' is allowed */
1624 goto err;
1625 format++;
1626 /* explicit fallthrough to string cases */
1627 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001628
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 case 's': /* string */
1630 case 'z': /* string or None */
1631 case 'y': /* bytes */
1632 case 'u': /* unicode string */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 case 'w': /* buffer, read-write */
1634 {
1635 (void) va_arg(*p_va, char **);
1636 if (*format == '#') {
1637 if (flags & FLAG_SIZE_T)
1638 (void) va_arg(*p_va, Py_ssize_t *);
1639 else
1640 (void) va_arg(*p_va, int *);
1641 format++;
1642 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1643 format++;
1644 }
1645 break;
1646 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 /* object codes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001649
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 case 'S': /* string object */
1651 case 'Y': /* string object */
1652 case 'U': /* unicode string object */
1653 {
1654 (void) va_arg(*p_va, PyObject **);
1655 break;
1656 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 case 'O': /* object */
1659 {
1660 if (*format == '!') {
1661 format++;
1662 (void) va_arg(*p_va, PyTypeObject*);
1663 (void) va_arg(*p_va, PyObject **);
1664 }
1665 else if (*format == '&') {
1666 typedef int (*converter)(PyObject *, void *);
1667 (void) va_arg(*p_va, converter);
1668 (void) va_arg(*p_va, void *);
1669 format++;
1670 }
1671 else {
1672 (void) va_arg(*p_va, PyObject **);
1673 }
1674 break;
1675 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 case '(': /* bypass tuple, not handled at all previously */
1678 {
1679 char *msg;
1680 for (;;) {
1681 if (*format==')')
1682 break;
1683 if (IS_END_OF_FORMAT(*format))
1684 return "Unmatched left paren in format "
1685 "string";
1686 msg = skipitem(&format, p_va, flags);
1687 if (msg)
1688 return msg;
1689 }
1690 format++;
1691 break;
1692 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001693
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001694 case ')':
1695 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00001696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001697 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001698err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001699 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001700
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001701 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001703 *p_format = format;
1704 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001705}
Fred Drakee4616e62001-10-23 21:09:29 +00001706
1707
1708int
Martin v. Löwis76246742006-03-01 04:06:10 +00001709PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001710{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 Py_ssize_t i, l;
1712 PyObject **o;
1713 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001714
1715#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001716 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001717#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001718 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001719#endif
1720
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 assert(min >= 0);
1722 assert(min <= max);
1723 if (!PyTuple_Check(args)) {
1724 PyErr_SetString(PyExc_SystemError,
1725 "PyArg_UnpackTuple() argument list is not a tuple");
1726 return 0;
1727 }
1728 l = PyTuple_GET_SIZE(args);
1729 if (l < min) {
1730 if (name != NULL)
1731 PyErr_Format(
1732 PyExc_TypeError,
1733 "%s expected %s%zd arguments, got %zd",
1734 name, (min == max ? "" : "at least "), min, l);
1735 else
1736 PyErr_Format(
1737 PyExc_TypeError,
1738 "unpacked tuple should have %s%zd elements,"
1739 " but has %zd",
1740 (min == max ? "" : "at least "), min, l);
1741 va_end(vargs);
1742 return 0;
1743 }
1744 if (l > max) {
1745 if (name != NULL)
1746 PyErr_Format(
1747 PyExc_TypeError,
1748 "%s expected %s%zd arguments, got %zd",
1749 name, (min == max ? "" : "at most "), max, l);
1750 else
1751 PyErr_Format(
1752 PyExc_TypeError,
1753 "unpacked tuple should have %s%zd elements,"
1754 " but has %zd",
1755 (min == max ? "" : "at most "), max, l);
1756 va_end(vargs);
1757 return 0;
1758 }
1759 for (i = 0; i < l; i++) {
1760 o = va_arg(vargs, PyObject **);
1761 *o = PyTuple_GET_ITEM(args, i);
1762 }
1763 va_end(vargs);
1764 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001765}
Georg Brandl02c42872005-08-26 06:42:30 +00001766
1767
1768/* For type constructors that don't take keyword args
1769 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001770 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001771 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001772 */
1773int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001774_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001775{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001776 if (kw == NULL)
1777 return 1;
1778 if (!PyDict_CheckExact(kw)) {
1779 PyErr_BadInternalCall();
1780 return 0;
1781 }
1782 if (PyDict_Size(kw) == 0)
1783 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001784
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1786 funcname);
1787 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001788}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001789#ifdef __cplusplus
1790};
1791#endif