blob: ab95e1e547b82ed8ce665510149c9e3a410db9ff [file] [log] [blame]
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001
2/* New getargs implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00005
Guido van Rossumc1d50531996-08-21 23:38:24 +00006#include <ctype.h>
7
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00008
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00009#ifdef __cplusplus
Guido van Rossum98297ee2007-11-06 21:34:58 +000010extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000011#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000012int PyArg_Parse(PyObject *, const char *, ...);
13int PyArg_ParseTuple(PyObject *, const char *, ...);
14int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000015
Tim Petersdbd9ba62000-07-09 03:09:57 +000016int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000017 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000018int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000019 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000020
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000021#ifdef HAVE_DECLSPEC_DLL
22/* Export functions */
23PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, char *, ...);
24PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, char *, ...);
25PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
26 const char *, char **, ...);
27PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
28PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, char *, va_list);
29PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
30 const char *, char **, va_list);
31#endif
32
Martin v. Löwis18e16552006-02-15 17:27:45 +000033#define FLAG_COMPAT 1
34#define FLAG_SIZE_T 2
35
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000036
37/* Forward */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000038static int vgetargs1(PyObject *, const char *, va_list *, int);
39static void seterror(int, const char *, int *, const char *, const char *);
Guido van Rossum98297ee2007-11-06 21:34:58 +000040static char *convertitem(PyObject *, const char **, va_list *, int, int *,
Martin v. Löwis18e16552006-02-15 17:27:45 +000041 char *, size_t, PyObject **);
42static char *converttuple(PyObject *, const char **, va_list *, int,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000043 int *, char *, size_t, int, PyObject **);
Martin v. Löwis18e16552006-02-15 17:27:45 +000044static char *convertsimple(PyObject *, const char **, va_list *, int, char *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000045 size_t, PyObject **);
Martin v. Löwis18e16552006-02-15 17:27:45 +000046static Py_ssize_t convertbuffer(PyObject *, void **p, char **);
Martin v. Löwis423be952008-08-13 15:53:07 +000047static int getbuffer(PyObject *, Py_buffer *, char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000048
Tim Petersdbd9ba62000-07-09 03:09:57 +000049static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000050 const char *, char **, va_list *, int);
Martin v. Löwis18e16552006-02-15 17:27:45 +000051static char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000052
Fred Drake563dfc22001-10-23 14:41:08 +000053int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000054PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000055{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000056 int retval;
57 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000059 va_start(va, format);
60 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
61 va_end(va);
62 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +000063}
64
65int
66_PyArg_Parse_SizeT(PyObject *args, char *format, ...)
67{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000068 int retval;
69 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000070
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000071 va_start(va, format);
72 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
73 va_end(va);
74 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000075}
76
77
Fred Drake563dfc22001-10-23 14:41:08 +000078int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000079PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000080{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000081 int retval;
82 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000084 va_start(va, format);
85 retval = vgetargs1(args, format, &va, 0);
86 va_end(va);
87 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000088}
89
Martin v. Löwis18e16552006-02-15 17:27:45 +000090int
91_PyArg_ParseTuple_SizeT(PyObject *args, char *format, ...)
92{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000093 int retval;
94 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000095
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000096 va_start(va, format);
97 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
98 va_end(va);
99 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000100}
101
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000102
103int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000104PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000105{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000106 va_list lva;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000107
108#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000109 memcpy(lva, va, sizeof(va_list));
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000110#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000111#ifdef __va_copy
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 __va_copy(lva, va);
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000113#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000114 lva = va;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000115#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000116#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000118 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000119}
120
Martin v. Löwis18e16552006-02-15 17:27:45 +0000121int
122_PyArg_VaParse_SizeT(PyObject *args, char *format, va_list va)
123{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000124 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000125
126#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000127 memcpy(lva, va, sizeof(va_list));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000128#else
129#ifdef __va_copy
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000130 __va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000131#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000132 lva = va;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000133#endif
134#endif
135
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000136 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000137}
138
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000139
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000140/* Handle cleanup of allocated memory in case of exception */
141
Benjamin Petersonb173f782009-05-05 22:31:58 +0000142#define GETARGS_CAPSULE_NAME_CLEANUP_PTR "getargs.cleanup_ptr"
143#define GETARGS_CAPSULE_NAME_CLEANUP_BUFFER "getargs.cleanup_buffer"
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000144#define GETARGS_CAPSULE_NAME_CLEANUP_CONVERT "getargs.cleanup_convert"
Benjamin Petersonb173f782009-05-05 22:31:58 +0000145
Antoine Pitrouf71995782008-08-29 18:37:05 +0000146static void
Benjamin Petersonb173f782009-05-05 22:31:58 +0000147cleanup_ptr(PyObject *self)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000148{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000149 void *ptr = PyCapsule_GetPointer(self, GETARGS_CAPSULE_NAME_CLEANUP_PTR);
150 if (ptr) {
151 PyMem_FREE(ptr);
152 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000153}
154
155static void
Benjamin Petersonb173f782009-05-05 22:31:58 +0000156cleanup_buffer(PyObject *self)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000157{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000158 Py_buffer *ptr = (Py_buffer *)PyCapsule_GetPointer(self, GETARGS_CAPSULE_NAME_CLEANUP_BUFFER);
159 if (ptr) {
160 PyBuffer_Release(ptr);
161 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000162}
163
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000164static int
Benjamin Petersonb173f782009-05-05 22:31:58 +0000165addcleanup(void *ptr, PyObject **freelist, PyCapsule_Destructor destr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000166{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000167 PyObject *cobj;
168 const char *name;
Benjamin Petersonb173f782009-05-05 22:31:58 +0000169
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170 if (!*freelist) {
171 *freelist = PyList_New(0);
172 if (!*freelist) {
173 destr(ptr);
174 return -1;
175 }
176 }
Benjamin Petersonb173f782009-05-05 22:31:58 +0000177
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000178 if (destr == cleanup_ptr) {
179 name = GETARGS_CAPSULE_NAME_CLEANUP_PTR;
180 } else if (destr == cleanup_buffer) {
181 name = GETARGS_CAPSULE_NAME_CLEANUP_BUFFER;
182 } else {
183 return -1;
184 }
185 cobj = PyCapsule_New(ptr, name, destr);
186 if (!cobj) {
187 destr(ptr);
188 return -1;
189 }
190 if (PyList_Append(*freelist, cobj)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000191 Py_DECREF(cobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000192 return -1;
193 }
194 Py_DECREF(cobj);
195 return 0;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000196}
197
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000198static void
199cleanup_convert(PyObject *self)
200{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000201 typedef int (*destr_t)(PyObject *, void *);
202 destr_t destr = (destr_t)PyCapsule_GetContext(self);
203 void *ptr = PyCapsule_GetPointer(self,
204 GETARGS_CAPSULE_NAME_CLEANUP_CONVERT);
205 if (ptr && destr)
206 destr(NULL, ptr);
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000207}
208
209static int
210addcleanup_convert(void *ptr, PyObject **freelist, int (*destr)(PyObject*,void*))
211{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000212 PyObject *cobj;
213 if (!*freelist) {
214 *freelist = PyList_New(0);
215 if (!*freelist) {
216 destr(NULL, ptr);
217 return -1;
218 }
219 }
220 cobj = PyCapsule_New(ptr, GETARGS_CAPSULE_NAME_CLEANUP_CONVERT,
221 cleanup_convert);
222 if (!cobj) {
223 destr(NULL, ptr);
224 return -1;
225 }
226 if (PyCapsule_SetContext(cobj, destr) == -1) {
227 /* This really should not happen. */
228 Py_FatalError("capsule refused setting of context.");
229 }
230 if (PyList_Append(*freelist, cobj)) {
231 Py_DECREF(cobj); /* This will also call destr. */
232 return -1;
233 }
234 Py_DECREF(cobj);
235 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000236}
237
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000238static int
239cleanreturn(int retval, PyObject *freelist)
240{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000241 if (freelist && retval != 0) {
242 /* We were successful, reset the destructors so that they
243 don't get called. */
244 Py_ssize_t len = PyList_GET_SIZE(freelist), i;
245 for (i = 0; i < len; i++)
246 PyCapsule_SetDestructor(PyList_GET_ITEM(freelist, i), NULL);
247 }
248 Py_XDECREF(freelist);
249 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000250}
251
252
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000253static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000254vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000255{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000256 char msgbuf[256];
257 int levels[32];
258 const char *fname = NULL;
259 const char *message = NULL;
260 int min = -1;
261 int max = 0;
262 int level = 0;
263 int endfmt = 0;
264 const char *formatsave = format;
265 Py_ssize_t i, len;
266 char *msg;
267 PyObject *freelist = NULL;
268 int compat = flags & FLAG_COMPAT;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000269
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000270 assert(compat || (args != (PyObject*)NULL));
271 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000272
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000273 while (endfmt == 0) {
274 int c = *format++;
275 switch (c) {
276 case '(':
277 if (level == 0)
278 max++;
279 level++;
280 if (level >= 30)
281 Py_FatalError("too many tuple nesting levels "
282 "in argument format string");
283 break;
284 case ')':
285 if (level == 0)
286 Py_FatalError("excess ')' in getargs format");
287 else
288 level--;
289 break;
290 case '\0':
291 endfmt = 1;
292 break;
293 case ':':
294 fname = format;
295 endfmt = 1;
296 break;
297 case ';':
298 message = format;
299 endfmt = 1;
300 break;
301 default:
302 if (level == 0) {
303 if (c == 'O')
304 max++;
305 else if (isalpha(Py_CHARMASK(c))) {
306 if (c != 'e') /* skip encoded */
307 max++;
308 } else if (c == '|')
309 min = max;
310 }
311 break;
312 }
313 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000315 if (level != 0)
316 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000318 if (min < 0)
319 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000320
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000321 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000323 if (compat) {
324 if (max == 0) {
325 if (args == NULL)
326 return 1;
327 PyOS_snprintf(msgbuf, sizeof(msgbuf),
328 "%.200s%s takes no arguments",
329 fname==NULL ? "function" : fname,
330 fname==NULL ? "" : "()");
331 PyErr_SetString(PyExc_TypeError, msgbuf);
332 return 0;
333 }
334 else if (min == 1 && max == 1) {
335 if (args == NULL) {
336 PyOS_snprintf(msgbuf, sizeof(msgbuf),
337 "%.200s%s takes at least one argument",
338 fname==NULL ? "function" : fname,
339 fname==NULL ? "" : "()");
340 PyErr_SetString(PyExc_TypeError, msgbuf);
341 return 0;
342 }
343 msg = convertitem(args, &format, p_va, flags, levels,
344 msgbuf, sizeof(msgbuf), &freelist);
345 if (msg == NULL)
346 return cleanreturn(1, freelist);
347 seterror(levels[0], msg, levels+1, fname, message);
348 return cleanreturn(0, freelist);
349 }
350 else {
351 PyErr_SetString(PyExc_SystemError,
352 "old style getargs format uses new features");
353 return 0;
354 }
355 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000356
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 if (!PyTuple_Check(args)) {
358 PyErr_SetString(PyExc_SystemError,
359 "new style getargs format but argument is not a tuple");
360 return 0;
361 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000363 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000365 if (len < min || max < len) {
366 if (message == NULL) {
367 PyOS_snprintf(msgbuf, sizeof(msgbuf),
368 "%.150s%s takes %s %d argument%s "
369 "(%ld given)",
370 fname==NULL ? "function" : fname,
371 fname==NULL ? "" : "()",
372 min==max ? "exactly"
373 : len < min ? "at least" : "at most",
374 len < min ? min : max,
375 (len < min ? min : max) == 1 ? "" : "s",
376 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
377 message = msgbuf;
378 }
379 PyErr_SetString(PyExc_TypeError, message);
380 return 0;
381 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000382
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000383 for (i = 0; i < len; i++) {
384 if (*format == '|')
385 format++;
386 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
387 flags, levels, msgbuf,
388 sizeof(msgbuf), &freelist);
389 if (msg) {
390 seterror(i+1, msg, levels, fname, msg);
391 return cleanreturn(0, freelist);
392 }
393 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000395 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
396 *format != '(' &&
397 *format != '|' && *format != ':' && *format != ';') {
398 PyErr_Format(PyExc_SystemError,
399 "bad format string: %.200s", formatsave);
400 return cleanreturn(0, freelist);
401 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000403 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000404}
405
406
407
408static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000409seterror(int iarg, const char *msg, int *levels, const char *fname,
410 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000411{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000412 char buf[512];
413 int i;
414 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000415
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000416 if (PyErr_Occurred())
417 return;
418 else if (message == NULL) {
419 if (fname != NULL) {
420 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
421 p += strlen(p);
422 }
423 if (iarg != 0) {
424 PyOS_snprintf(p, sizeof(buf) - (p - buf),
425 "argument %d", iarg);
426 i = 0;
427 p += strlen(p);
428 while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
429 PyOS_snprintf(p, sizeof(buf) - (p - buf),
430 ", item %d", levels[i]-1);
431 p += strlen(p);
432 i++;
433 }
434 }
435 else {
436 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
437 p += strlen(p);
438 }
439 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
440 message = buf;
441 }
442 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000443}
444
445
446/* Convert a tuple argument.
447 On entry, *p_format points to the character _after_ the opening '('.
448 On successful exit, *p_format points to the closing ')'.
449 If successful:
450 *p_format and *p_va are updated,
451 *levels and *msgbuf are untouched,
452 and NULL is returned.
453 If the argument is invalid:
454 *p_format is unchanged,
455 *p_va is undefined,
456 *levels is a 0-terminated list of item numbers,
457 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000458 "must be <typename1>, not <typename2>", where:
459 <typename1> is the name of the expected type, and
460 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000461 and msgbuf is returned.
462*/
463
464static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000465converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000466 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000467 PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000468{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000469 int level = 0;
470 int n = 0;
471 const char *format = *p_format;
472 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000474 for (;;) {
475 int c = *format++;
476 if (c == '(') {
477 if (level == 0)
478 n++;
479 level++;
480 }
481 else if (c == ')') {
482 if (level == 0)
483 break;
484 level--;
485 }
486 else if (c == ':' || c == ';' || c == '\0')
487 break;
488 else if (level == 0 && isalpha(Py_CHARMASK(c)))
489 n++;
490 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000492 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
493 levels[0] = 0;
494 PyOS_snprintf(msgbuf, bufsize,
495 toplevel ? "expected %d arguments, not %.50s" :
496 "must be %d-item sequence, not %.50s",
497 n,
498 arg == Py_None ? "None" : arg->ob_type->tp_name);
499 return msgbuf;
500 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000501
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000502 if ((i = PySequence_Size(arg)) != n) {
503 levels[0] = 0;
504 PyOS_snprintf(msgbuf, bufsize,
505 toplevel ? "expected %d arguments, not %d" :
506 "must be sequence of length %d, not %d",
507 n, i);
508 return msgbuf;
509 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 format = *p_format;
512 for (i = 0; i < n; i++) {
513 char *msg;
514 PyObject *item;
515 item = PySequence_GetItem(arg, i);
516 if (item == NULL) {
517 PyErr_Clear();
518 levels[0] = i+1;
519 levels[1] = 0;
520 strncpy(msgbuf, "is not retrievable", bufsize);
521 return msgbuf;
522 }
523 msg = convertitem(item, &format, p_va, flags, levels+1,
524 msgbuf, bufsize, freelist);
525 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
526 Py_XDECREF(item);
527 if (msg != NULL) {
528 levels[0] = i+1;
529 return msg;
530 }
531 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 *p_format = format;
534 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000535}
536
537
538/* Convert a single item. */
539
540static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000541convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
542 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000543{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000544 char *msg;
545 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000547 if (*format == '(' /* ')' */) {
548 format++;
549 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
550 bufsize, 0, freelist);
551 if (msg == NULL)
552 format++;
553 }
554 else {
555 msg = convertsimple(arg, &format, p_va, flags,
556 msgbuf, bufsize, freelist);
557 if (msg != NULL)
558 levels[0] = 0;
559 }
560 if (msg == NULL)
561 *p_format = format;
562 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000563}
564
565
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000566
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000567#define UNICODE_DEFAULT_ENCODING(arg) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000568 _PyUnicode_AsDefaultEncodedString(arg, NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000569
570/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000571
572static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000573converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000574{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000575 assert(expected != NULL);
576 assert(arg != NULL);
577 PyOS_snprintf(msgbuf, bufsize,
578 "must be %.50s, not %.50s", expected,
579 arg == Py_None ? "None" : arg->ob_type->tp_name);
580 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000581}
582
583#define CONV_UNICODE "(unicode conversion error)"
584
Guido van Rossum45aecf42006-03-15 04:58:47 +0000585/* Explicitly check for float arguments when integers are expected.
586 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000587static int
588float_argument_error(PyObject *arg)
589{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000590 if (PyFloat_Check(arg)) {
591 PyErr_SetString(PyExc_TypeError,
592 "integer argument expected, got float" );
593 return 1;
594 }
595 else
596 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000597}
598
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000599/* Convert a non-tuple argument. Return NULL if conversion went OK,
600 or a string with a message describing the failure. The message is
601 formatted as "must be <desired type>, not <actual type>".
602 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000603 Don't call if a tuple is expected.
604
605 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000606*/
607
608static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000609convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000610 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000611{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000612 /* For # codes */
613#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
614 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
615 else q=va_arg(*p_va, int*);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000616#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
617#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 const char *format = *p_format;
620 char c = *format++;
621 PyObject *uarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000622
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000623 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000624
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 case 'b': { /* unsigned byte -- very short int */
626 char *p = va_arg(*p_va, char *);
627 long ival;
628 if (float_argument_error(arg))
629 return converterr("integer<b>", arg, msgbuf, bufsize);
630 ival = PyLong_AsLong(arg);
631 if (ival == -1 && PyErr_Occurred())
632 return converterr("integer<b>", arg, msgbuf, bufsize);
633 else if (ival < 0) {
634 PyErr_SetString(PyExc_OverflowError,
635 "unsigned byte integer is less than minimum");
636 return converterr("integer<b>", arg, msgbuf, bufsize);
637 }
638 else if (ival > UCHAR_MAX) {
639 PyErr_SetString(PyExc_OverflowError,
640 "unsigned byte integer is greater than maximum");
641 return converterr("integer<b>", arg, msgbuf, bufsize);
642 }
643 else
644 *p = (unsigned char) ival;
645 break;
646 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000648 case 'B': {/* byte sized bitfield - both signed and unsigned
649 values allowed */
650 char *p = va_arg(*p_va, char *);
651 long ival;
652 if (float_argument_error(arg))
653 return converterr("integer<B>", arg, msgbuf, bufsize);
654 ival = PyLong_AsUnsignedLongMask(arg);
655 if (ival == -1 && PyErr_Occurred())
656 return converterr("integer<B>", arg, msgbuf, bufsize);
657 else
658 *p = (unsigned char) ival;
659 break;
660 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000662 case 'h': {/* signed short int */
663 short *p = va_arg(*p_va, short *);
664 long ival;
665 if (float_argument_error(arg))
666 return converterr("integer<h>", arg, msgbuf, bufsize);
667 ival = PyLong_AsLong(arg);
668 if (ival == -1 && PyErr_Occurred())
669 return converterr("integer<h>", arg, msgbuf, bufsize);
670 else if (ival < SHRT_MIN) {
671 PyErr_SetString(PyExc_OverflowError,
672 "signed short integer is less than minimum");
673 return converterr("integer<h>", arg, msgbuf, bufsize);
674 }
675 else if (ival > SHRT_MAX) {
676 PyErr_SetString(PyExc_OverflowError,
677 "signed short integer is greater than maximum");
678 return converterr("integer<h>", arg, msgbuf, bufsize);
679 }
680 else
681 *p = (short) ival;
682 break;
683 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000685 case 'H': { /* short int sized bitfield, both signed and
686 unsigned allowed */
687 unsigned short *p = va_arg(*p_va, unsigned short *);
688 long ival;
689 if (float_argument_error(arg))
690 return converterr("integer<H>", arg, msgbuf, bufsize);
691 ival = PyLong_AsUnsignedLongMask(arg);
692 if (ival == -1 && PyErr_Occurred())
693 return converterr("integer<H>", arg, msgbuf, bufsize);
694 else
695 *p = (unsigned short) ival;
696 break;
697 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 case 'i': {/* signed int */
700 int *p = va_arg(*p_va, int *);
701 long ival;
702 if (float_argument_error(arg))
703 return converterr("integer<i>", arg, msgbuf, bufsize);
704 ival = PyLong_AsLong(arg);
705 if (ival == -1 && PyErr_Occurred())
706 return converterr("integer<i>", arg, msgbuf, bufsize);
707 else if (ival > INT_MAX) {
708 PyErr_SetString(PyExc_OverflowError,
709 "signed integer is greater than maximum");
710 return converterr("integer<i>", arg, msgbuf, bufsize);
711 }
712 else if (ival < INT_MIN) {
713 PyErr_SetString(PyExc_OverflowError,
714 "signed integer is less than minimum");
715 return converterr("integer<i>", arg, msgbuf, bufsize);
716 }
717 else
718 *p = ival;
719 break;
720 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000721
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000722 case 'I': { /* int sized bitfield, both signed and
723 unsigned allowed */
724 unsigned int *p = va_arg(*p_va, unsigned int *);
725 unsigned int ival;
726 if (float_argument_error(arg))
727 return converterr("integer<I>", arg, msgbuf, bufsize);
728 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
729 if (ival == (unsigned int)-1 && PyErr_Occurred())
730 return converterr("integer<I>", arg, msgbuf, bufsize);
731 else
732 *p = ival;
733 break;
734 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 case 'n': /* Py_ssize_t */
737 {
738 PyObject *iobj;
739 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
740 Py_ssize_t ival = -1;
741 if (float_argument_error(arg))
742 return converterr("integer<n>", arg, msgbuf, bufsize);
743 iobj = PyNumber_Index(arg);
744 if (iobj != NULL) {
745 ival = PyLong_AsSsize_t(iobj);
746 Py_DECREF(iobj);
747 }
748 if (ival == -1 && PyErr_Occurred())
749 return converterr("integer<n>", arg, msgbuf, bufsize);
750 *p = ival;
751 break;
752 }
753 case 'l': {/* long int */
754 long *p = va_arg(*p_va, long *);
755 long ival;
756 if (float_argument_error(arg))
757 return converterr("integer<l>", arg, msgbuf, bufsize);
758 ival = PyLong_AsLong(arg);
759 if (ival == -1 && PyErr_Occurred())
760 return converterr("integer<l>", arg, msgbuf, bufsize);
761 else
762 *p = ival;
763 break;
764 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000765
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000766 case 'k': { /* long sized bitfield */
767 unsigned long *p = va_arg(*p_va, unsigned long *);
768 unsigned long ival;
769 if (PyLong_Check(arg))
770 ival = PyLong_AsUnsignedLongMask(arg);
771 else
772 return converterr("integer<k>", arg, msgbuf, bufsize);
773 *p = ival;
774 break;
775 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000776
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000777#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 case 'L': {/* PY_LONG_LONG */
779 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
780 PY_LONG_LONG ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000781 if (float_argument_error(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000782 return converterr("long<L>", arg, msgbuf, bufsize);
783 ival = PyLong_AsLongLong(arg);
Mark Dickinsonc7301312010-06-10 16:05:10 +0000784 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred())
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000785 return converterr("long<L>", arg, msgbuf, bufsize);
Mark Dickinsonc7301312010-06-10 16:05:10 +0000786 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000788 break;
789 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000791 case 'K': { /* long long sized bitfield */
792 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
793 unsigned PY_LONG_LONG ival;
794 if (PyLong_Check(arg))
795 ival = PyLong_AsUnsignedLongLongMask(arg);
796 else
797 return converterr("integer<K>", arg, msgbuf, bufsize);
798 *p = ival;
799 break;
800 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000801#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 case 'f': {/* float */
804 float *p = va_arg(*p_va, float *);
805 double dval = PyFloat_AsDouble(arg);
806 if (PyErr_Occurred())
807 return converterr("float<f>", arg, msgbuf, bufsize);
808 else
809 *p = (float) dval;
810 break;
811 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000812
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 case 'd': {/* double */
814 double *p = va_arg(*p_va, double *);
815 double dval = PyFloat_AsDouble(arg);
816 if (PyErr_Occurred())
817 return converterr("float<d>", arg, msgbuf, bufsize);
818 else
819 *p = dval;
820 break;
821 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000822
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 case 'D': {/* complex double */
824 Py_complex *p = va_arg(*p_va, Py_complex *);
825 Py_complex cval;
826 cval = PyComplex_AsCComplex(arg);
827 if (PyErr_Occurred())
828 return converterr("complex<D>", arg, msgbuf, bufsize);
829 else
830 *p = cval;
831 break;
832 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000833
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000834 case 'c': {/* char */
835 char *p = va_arg(*p_va, char *);
836 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
837 *p = PyBytes_AS_STRING(arg)[0];
838 else
839 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
840 break;
841 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000842
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 case 'C': {/* unicode char */
844 int *p = va_arg(*p_va, int *);
845 if (PyUnicode_Check(arg) &&
846 PyUnicode_GET_SIZE(arg) == 1)
847 *p = PyUnicode_AS_UNICODE(arg)[0];
848 else
849 return converterr("a unicode character", arg, msgbuf, bufsize);
850 break;
851 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000852
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000853 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000854 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000855
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 case 'y': {/* any buffer-like object, but not PyUnicode */
857 void **p = (void **)va_arg(*p_va, char **);
858 char *buf;
859 Py_ssize_t count;
860 if (*format == '*') {
861 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
862 return converterr(buf, arg, msgbuf, bufsize);
863 format++;
864 if (addcleanup(p, freelist, cleanup_buffer)) {
865 return converterr(
866 "(cleanup problem)",
867 arg, msgbuf, bufsize);
868 }
869 break;
870 }
871 count = convertbuffer(arg, p, &buf);
872 if (count < 0)
873 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000874 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000875 FETCH_SIZE;
876 STORE_SIZE(count);
877 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000878 } else {
879 if (strlen(*p) != count)
880 return converterr(
881 "bytes without null bytes",
882 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 }
884 break;
885 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000886
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000887 case 's': /* text string */
888 case 'z': /* text string or None */
889 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000890 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000891 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000892 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000893
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000894 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000895 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
896 else if (PyUnicode_Check(arg)) {
897 uarg = UNICODE_DEFAULT_ENCODING(arg);
898 if (uarg == NULL)
899 return converterr(CONV_UNICODE,
900 arg, msgbuf, bufsize);
901 PyBuffer_FillInfo(p, arg,
902 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
903 1, 0);
904 }
905 else { /* any buffer-like object */
906 char *buf;
907 if (getbuffer(arg, p, &buf) < 0)
908 return converterr(buf, arg, msgbuf, bufsize);
909 }
910 if (addcleanup(p, freelist, cleanup_buffer)) {
911 return converterr(
912 "(cleanup problem)",
913 arg, msgbuf, bufsize);
914 }
915 format++;
916 } else if (*format == '#') { /* any buffer-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000917 /* "s#" or "z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 void **p = (void **)va_arg(*p_va, char **);
919 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000920
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000921 if (c == 'z' && arg == Py_None) {
922 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000923 STORE_SIZE(0);
924 }
925 else if (PyUnicode_Check(arg)) {
926 uarg = UNICODE_DEFAULT_ENCODING(arg);
927 if (uarg == NULL)
928 return converterr(CONV_UNICODE,
929 arg, msgbuf, bufsize);
930 *p = PyBytes_AS_STRING(uarg);
931 STORE_SIZE(PyBytes_GET_SIZE(uarg));
932 }
933 else { /* any buffer-like object */
934 /* XXX Really? */
935 char *buf;
936 Py_ssize_t count = convertbuffer(arg, p, &buf);
937 if (count < 0)
938 return converterr(buf, arg, msgbuf, bufsize);
939 STORE_SIZE(count);
940 }
941 format++;
942 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000943 /* "s" or "z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000944 char **p = va_arg(*p_va, char **);
945 uarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000946
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000947 if (c == 'z' && arg == Py_None)
948 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 else if (PyUnicode_Check(arg)) {
950 uarg = UNICODE_DEFAULT_ENCODING(arg);
951 if (uarg == NULL)
952 return converterr(CONV_UNICODE,
953 arg, msgbuf, bufsize);
954 *p = PyBytes_AS_STRING(uarg);
955 }
956 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000957 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 arg, msgbuf, bufsize);
Victor Stinner43fb0092010-05-29 00:13:06 +0000959 if (*p != NULL && uarg != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 (Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
961 return converterr(
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000962 c == 'z' ? "str without null bytes or None"
963 : "str without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000964 arg, msgbuf, bufsize);
965 }
966 break;
967 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000968
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000969 case 'u': /* raw unicode buffer (Py_UNICODE *) */
970 case 'Z': /* raw unicode buffer or None */
971 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 if (*format == '#') { /* any buffer-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000973 /* "s#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
975 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000976
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000977 if (c == 'Z' && arg == Py_None) {
978 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000979 STORE_SIZE(0);
980 }
981 else if (PyUnicode_Check(arg)) {
982 *p = PyUnicode_AS_UNICODE(arg);
983 STORE_SIZE(PyUnicode_GET_SIZE(arg));
984 }
Victor Stinner5216e6d2010-06-08 21:45:51 +0000985 else
986 return converterr("str or None", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 format++;
988 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000989 /* "s" or "Z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000990 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000991
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000992 if (c == 'Z' && arg == Py_None)
993 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000994 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 *p = PyUnicode_AS_UNICODE(arg);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000996 if (Py_UNICODE_strlen(*p) != PyUnicode_GET_SIZE(arg))
997 return converterr(
998 "str without null character or None",
999 arg, msgbuf, bufsize);
1000 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001001 return converterr(c == 'Z' ? "str or None" : "str",
1002 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001003 }
1004 break;
1005 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001007 case 'e': {/* encoded string */
1008 char **buffer;
1009 const char *encoding;
1010 PyObject *s;
1011 int recode_strings;
1012 Py_ssize_t size;
1013 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001015 /* Get 'e' parameter: the encoding name */
1016 encoding = (const char *)va_arg(*p_va, const char *);
1017 if (encoding == NULL)
1018 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001019
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001020 /* Get output buffer parameter:
1021 's' (recode all objects via Unicode) or
1022 't' (only recode non-string objects)
1023 */
1024 if (*format == 's')
1025 recode_strings = 1;
1026 else if (*format == 't')
1027 recode_strings = 0;
1028 else
1029 return converterr(
1030 "(unknown parser marker combination)",
1031 arg, msgbuf, bufsize);
1032 buffer = (char **)va_arg(*p_va, char **);
1033 format++;
1034 if (buffer == NULL)
1035 return converterr("(buffer is NULL)",
1036 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001037
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001038 /* Encode object */
1039 if (!recode_strings &&
1040 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1041 s = arg;
1042 Py_INCREF(s);
1043 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1044 return converterr("(AsCharBuffer failed)",
1045 arg, msgbuf, bufsize);
1046 }
1047 else {
1048 PyObject *u;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001049
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001050 /* Convert object to Unicode */
1051 u = PyUnicode_FromObject(arg);
1052 if (u == NULL)
1053 return converterr(
1054 "string or unicode or text buffer",
1055 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001056
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001057 /* Encode object; use default error handling */
1058 s = PyUnicode_AsEncodedString(u,
1059 encoding,
1060 NULL);
1061 Py_DECREF(u);
1062 if (s == NULL)
1063 return converterr("(encoding failed)",
1064 arg, msgbuf, bufsize);
1065 if (!PyBytes_Check(s)) {
1066 Py_DECREF(s);
1067 return converterr(
1068 "(encoder failed to return bytes)",
1069 arg, msgbuf, bufsize);
1070 }
1071 size = PyBytes_GET_SIZE(s);
1072 ptr = PyBytes_AS_STRING(s);
1073 if (ptr == NULL)
1074 ptr = "";
1075 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001076
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001077 /* Write output; output is guaranteed to be 0-terminated */
1078 if (*format == '#') {
1079 /* Using buffer length parameter '#':
1080
1081 - if *buffer is NULL, a new buffer of the
1082 needed size is allocated and the data
1083 copied into it; *buffer is updated to point
1084 to the new buffer; the caller is
1085 responsible for PyMem_Free()ing it after
1086 usage
1087
1088 - if *buffer is not NULL, the data is
1089 copied to *buffer; *buffer_len has to be
1090 set to the size of the buffer on input;
1091 buffer overflow is signalled with an error;
1092 buffer has to provide enough room for the
1093 encoded string plus the trailing 0-byte
1094
1095 - in both cases, *buffer_len is updated to
1096 the size of the buffer /excluding/ the
1097 trailing 0-byte
1098
1099 */
1100 FETCH_SIZE;
1101
1102 format++;
1103 if (q == NULL && q2 == NULL) {
1104 Py_DECREF(s);
1105 return converterr(
1106 "(buffer_len is NULL)",
1107 arg, msgbuf, bufsize);
1108 }
1109 if (*buffer == NULL) {
1110 *buffer = PyMem_NEW(char, size + 1);
1111 if (*buffer == NULL) {
1112 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001113 PyErr_NoMemory();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 return converterr(
1115 "(memory error)",
1116 arg, msgbuf, bufsize);
1117 }
1118 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1119 Py_DECREF(s);
1120 return converterr(
1121 "(cleanup problem)",
1122 arg, msgbuf, bufsize);
1123 }
1124 } else {
1125 if (size + 1 > BUFFER_LEN) {
1126 Py_DECREF(s);
1127 return converterr(
1128 "(buffer overflow)",
1129 arg, msgbuf, bufsize);
1130 }
1131 }
1132 memcpy(*buffer, ptr, size+1);
1133 STORE_SIZE(size);
1134 } else {
1135 /* Using a 0-terminated buffer:
1136
1137 - the encoded string has to be 0-terminated
1138 for this variant to work; if it is not, an
1139 error raised
1140
1141 - a new buffer of the needed size is
1142 allocated and the data copied into it;
1143 *buffer is updated to point to the new
1144 buffer; the caller is responsible for
1145 PyMem_Free()ing it after usage
1146
1147 */
1148 if ((Py_ssize_t)strlen(ptr) != size) {
1149 Py_DECREF(s);
1150 return converterr(
1151 "encoded string without NULL bytes",
1152 arg, msgbuf, bufsize);
1153 }
1154 *buffer = PyMem_NEW(char, size + 1);
1155 if (*buffer == NULL) {
1156 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001157 PyErr_NoMemory();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001158 return converterr("(memory error)",
1159 arg, msgbuf, bufsize);
1160 }
1161 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
1162 Py_DECREF(s);
1163 return converterr("(cleanup problem)",
1164 arg, msgbuf, bufsize);
1165 }
1166 memcpy(*buffer, ptr, size+1);
1167 }
1168 Py_DECREF(s);
1169 break;
1170 }
1171
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001172 case 'S': { /* PyBytes object */
1173 PyObject **p = va_arg(*p_va, PyObject **);
1174 if (PyBytes_Check(arg))
1175 *p = arg;
1176 else
1177 return converterr("bytes", arg, msgbuf, bufsize);
1178 break;
1179 }
1180
1181 case 'Y': { /* PyByteArray object */
1182 PyObject **p = va_arg(*p_va, PyObject **);
1183 if (PyByteArray_Check(arg))
1184 *p = arg;
1185 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001186 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001187 break;
1188 }
1189
1190 case 'U': { /* PyUnicode object */
1191 PyObject **p = va_arg(*p_va, PyObject **);
1192 if (PyUnicode_Check(arg))
1193 *p = arg;
1194 else
1195 return converterr("str", arg, msgbuf, bufsize);
1196 break;
1197 }
1198
1199 case 'O': { /* object */
1200 PyTypeObject *type;
1201 PyObject **p;
1202 if (*format == '!') {
1203 type = va_arg(*p_va, PyTypeObject*);
1204 p = va_arg(*p_va, PyObject **);
1205 format++;
1206 if (PyType_IsSubtype(arg->ob_type, type))
1207 *p = arg;
1208 else
1209 return converterr(type->tp_name, arg, msgbuf, bufsize);
1210
1211 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001212 else if (*format == '&') {
1213 typedef int (*converter)(PyObject *, void *);
1214 converter convert = va_arg(*p_va, converter);
1215 void *addr = va_arg(*p_va, void *);
1216 int res;
1217 format++;
1218 if (! (res = (*convert)(arg, addr)))
1219 return converterr("(unspecified)",
1220 arg, msgbuf, bufsize);
1221 if (res == Py_CLEANUP_SUPPORTED &&
1222 addcleanup_convert(addr, freelist, convert) == -1)
1223 return converterr("(cleanup problem)",
1224 arg, msgbuf, bufsize);
1225 }
1226 else {
1227 p = va_arg(*p_va, PyObject **);
1228 *p = arg;
1229 }
1230 break;
1231 }
1232
1233
1234 case 'w': { /* memory buffer, read-write access */
1235 void **p = va_arg(*p_va, void **);
1236 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1237 Py_ssize_t count;
1238 int temp=-1;
1239 Py_buffer view;
1240
1241 if (pb && pb->bf_releasebuffer && *format != '*')
1242 /* Buffer must be released, yet caller does not use
1243 the Py_buffer protocol. */
1244 return converterr("pinned buffer", arg, msgbuf, bufsize);
1245
1246
1247 if (pb && pb->bf_getbuffer && *format == '*') {
1248 /* Caller is interested in Py_buffer, and the object
1249 supports it directly. */
1250 format++;
1251 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1252 PyErr_Clear();
1253 return converterr("read-write buffer", arg, msgbuf, bufsize);
1254 }
1255 if (addcleanup(p, freelist, cleanup_buffer)) {
1256 return converterr(
1257 "(cleanup problem)",
1258 arg, msgbuf, bufsize);
1259 }
1260 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C'))
1261 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1262 break;
1263 }
1264
1265 /* Here we have processed w*, only w and w# remain. */
1266 if (pb == NULL ||
1267 pb->bf_getbuffer == NULL ||
1268 ((temp = PyObject_GetBuffer(arg, &view,
1269 PyBUF_SIMPLE)) != 0) ||
1270 view.readonly == 1) {
1271 if (temp==0) {
1272 PyBuffer_Release(&view);
1273 }
1274 return converterr("single-segment read-write buffer",
1275 arg, msgbuf, bufsize);
1276 }
1277
1278 if ((count = view.len) < 0)
1279 return converterr("(unspecified)", arg, msgbuf, bufsize);
1280 *p = view.buf;
1281 if (*format == '#') {
1282 FETCH_SIZE;
1283 STORE_SIZE(count);
1284 format++;
1285 }
1286 break;
1287 }
1288
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001289 default:
1290 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
1291
1292 }
1293
1294 *p_format = format;
1295 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001296}
Guido van Rossumaa354651996-08-19 19:32:04 +00001297
Martin v. Löwis18e16552006-02-15 17:27:45 +00001298static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001299convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001300{
Victor Stinner5cb62392010-06-06 20:27:51 +00001301 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001302 Py_ssize_t count;
1303 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 *errmsg = NULL;
1306 *p = NULL;
1307 if (pb == NULL ||
1308 pb->bf_getbuffer == NULL ||
1309 pb->bf_releasebuffer != NULL) {
1310 *errmsg = "bytes or read-only buffer";
1311 return -1;
1312 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001314 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0) {
1315 *errmsg = "bytes or single-segment read-only buffer";
1316 return -1;
1317 }
1318 count = view.len;
1319 *p = view.buf;
1320 PyBuffer_Release(&view);
1321 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001322}
Guido van Rossumaa354651996-08-19 19:32:04 +00001323
Martin v. Löwis423be952008-08-13 15:53:07 +00001324/* XXX for 3.x, getbuffer and convertbuffer can probably
1325 be merged again. */
1326static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001327getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001328{
Victor Stinner5cb62392010-06-06 20:27:51 +00001329 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001330 if (pb == NULL) {
1331 *errmsg = "bytes or buffer";
1332 return -1;
1333 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001334 if (pb->bf_getbuffer == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001335 *errmsg = "convertible to a buffer";
Victor Stinner5cb62392010-06-06 20:27:51 +00001336 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001338 if (PyObject_GetBuffer(arg, view, 0) < 0) {
1339 *errmsg = "convertible to a buffer";
1340 return -1;
1341 }
1342 if (!PyBuffer_IsContiguous(view, 'C')) {
1343 *errmsg = "contiguous buffer";
1344 return -1;
1345 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001347}
1348
Guido van Rossumaa354651996-08-19 19:32:04 +00001349/* Support for keyword arguments donated by
1350 Geoff Philbrick <philbric@delphi.hks.com> */
1351
Tim Petersf8cd3e82001-10-27 04:26:57 +00001352/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001353int
1354PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001355 PyObject *keywords,
1356 const char *format,
1357 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001358{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001359 int retval;
1360 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001361
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001362 if ((args == NULL || !PyTuple_Check(args)) ||
1363 (keywords != NULL && !PyDict_Check(keywords)) ||
1364 format == NULL ||
1365 kwlist == NULL)
1366 {
1367 PyErr_BadInternalCall();
1368 return 0;
1369 }
Tim Peters45772cd2001-10-27 03:58:40 +00001370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001371 va_start(va, kwlist);
1372 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1373 va_end(va);
1374 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001375}
1376
1377int
1378_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 PyObject *keywords,
1380 const char *format,
1381 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001382{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001383 int retval;
1384 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001385
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001386 if ((args == NULL || !PyTuple_Check(args)) ||
1387 (keywords != NULL && !PyDict_Check(keywords)) ||
1388 format == NULL ||
1389 kwlist == NULL)
1390 {
1391 PyErr_BadInternalCall();
1392 return 0;
1393 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 va_start(va, kwlist);
1396 retval = vgetargskeywords(args, keywords, format,
1397 kwlist, &va, FLAG_SIZE_T);
1398 va_end(va);
1399 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001400}
1401
1402
Brett Cannon711e7d92004-07-10 22:20:32 +00001403int
1404PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001405 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001406 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001407 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001408{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001409 int retval;
1410 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001412 if ((args == NULL || !PyTuple_Check(args)) ||
1413 (keywords != NULL && !PyDict_Check(keywords)) ||
1414 format == NULL ||
1415 kwlist == NULL)
1416 {
1417 PyErr_BadInternalCall();
1418 return 0;
1419 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001420
1421#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001422 memcpy(lva, va, sizeof(va_list));
Brett Cannon711e7d92004-07-10 22:20:32 +00001423#else
1424#ifdef __va_copy
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001425 __va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001426#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 lva = va;
Brett Cannon711e7d92004-07-10 22:20:32 +00001428#endif
1429#endif
1430
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001431 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1432 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001433}
1434
1435int
1436_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001437 PyObject *keywords,
1438 const char *format,
1439 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001440{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 int retval;
1442 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 if ((args == NULL || !PyTuple_Check(args)) ||
1445 (keywords != NULL && !PyDict_Check(keywords)) ||
1446 format == NULL ||
1447 kwlist == NULL)
1448 {
1449 PyErr_BadInternalCall();
1450 return 0;
1451 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001452
1453#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 memcpy(lva, va, sizeof(va_list));
Martin v. Löwis18e16552006-02-15 17:27:45 +00001455#else
1456#ifdef __va_copy
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001457 __va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001458#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001459 lva = va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001460#endif
1461#endif
1462
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 retval = vgetargskeywords(args, keywords, format,
1464 kwlist, &lva, FLAG_SIZE_T);
1465 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001466}
1467
Benjamin Petersonfb886362010-04-24 18:21:17 +00001468int
1469PyArg_ValidateKeywordArguments(PyObject *kwargs)
1470{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001471 if (!PyDict_CheckExact(kwargs)) {
1472 PyErr_BadInternalCall();
1473 return 0;
1474 }
1475 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1476 PyErr_SetString(PyExc_TypeError,
1477 "keyword arguments must be strings");
1478 return 0;
1479 }
1480 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001481}
1482
Christian Heimes380f7f22008-02-28 11:19:05 +00001483#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001484
Guido van Rossumaa354651996-08-19 19:32:04 +00001485static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001486vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001488{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001489 char msgbuf[512];
1490 int levels[32];
1491 const char *fname, *msg, *custom_msg, *keyword;
1492 int min = INT_MAX;
1493 int i, len, nargs, nkeywords;
1494 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 assert(args != NULL && PyTuple_Check(args));
1497 assert(keywords == NULL || PyDict_Check(keywords));
1498 assert(format != NULL);
1499 assert(kwlist != NULL);
1500 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001501
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001502 /* grab the function name or custom error msg first (mutually exclusive) */
1503 fname = strchr(format, ':');
1504 if (fname) {
1505 fname++;
1506 custom_msg = NULL;
1507 }
1508 else {
1509 custom_msg = strchr(format,';');
1510 if (custom_msg)
1511 custom_msg++;
1512 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001514 /* scan kwlist and get greatest possible nbr of args */
1515 for (len=0; kwlist[len]; len++)
1516 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 nargs = PyTuple_GET_SIZE(args);
1519 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1520 if (nargs + nkeywords > len) {
1521 PyErr_Format(PyExc_TypeError, "%s%s takes at most %d "
1522 "argument%s (%d given)",
1523 (fname == NULL) ? "function" : fname,
1524 (fname == NULL) ? "" : "()",
1525 len,
1526 (len == 1) ? "" : "s",
1527 nargs + nkeywords);
1528 return 0;
1529 }
Tim Petersc2f01122001-10-27 07:25:06 +00001530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001531 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1532 for (i = 0; i < len; i++) {
1533 keyword = kwlist[i];
1534 if (*format == '|') {
1535 min = i;
1536 format++;
1537 }
1538 if (IS_END_OF_FORMAT(*format)) {
1539 PyErr_Format(PyExc_RuntimeError,
1540 "More keyword list entries (%d) than "
1541 "format specifiers (%d)", len, i);
1542 return cleanreturn(0, freelist);
1543 }
1544 current_arg = NULL;
1545 if (nkeywords) {
1546 current_arg = PyDict_GetItemString(keywords, keyword);
1547 }
1548 if (current_arg) {
1549 --nkeywords;
1550 if (i < nargs) {
1551 /* arg present in tuple and in dict */
1552 PyErr_Format(PyExc_TypeError,
1553 "Argument given by name ('%s') "
1554 "and position (%d)",
1555 keyword, i+1);
1556 return cleanreturn(0, freelist);
1557 }
1558 }
1559 else if (nkeywords && PyErr_Occurred())
1560 return cleanreturn(0, freelist);
1561 else if (i < nargs)
1562 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimes380f7f22008-02-28 11:19:05 +00001563
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001564 if (current_arg) {
1565 msg = convertitem(current_arg, &format, p_va, flags,
1566 levels, msgbuf, sizeof(msgbuf), &freelist);
1567 if (msg) {
1568 seterror(i+1, msg, levels, fname, custom_msg);
1569 return cleanreturn(0, freelist);
1570 }
1571 continue;
1572 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001573
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001574 if (i < min) {
1575 PyErr_Format(PyExc_TypeError, "Required argument "
1576 "'%s' (pos %d) not found",
1577 keyword, i+1);
1578 return cleanreturn(0, freelist);
1579 }
1580 /* current code reports success when all required args
1581 * fulfilled and no keyword args left, with no further
1582 * validation. XXX Maybe skip this in debug build ?
1583 */
1584 if (!nkeywords)
1585 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001586
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001587 /* We are into optional args, skip thru to any remaining
1588 * keyword args */
1589 msg = skipitem(&format, p_va, flags);
1590 if (msg) {
1591 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1592 format);
1593 return cleanreturn(0, freelist);
1594 }
1595 }
Tim Petersb054be42001-10-27 05:07:41 +00001596
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
1598 PyErr_Format(PyExc_RuntimeError,
1599 "more argument specifiers than keyword list entries "
1600 "(remaining format:'%s')", format);
1601 return cleanreturn(0, freelist);
1602 }
Tim Petersc2f01122001-10-27 07:25:06 +00001603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 /* make sure there are no extraneous keyword arguments */
1605 if (nkeywords > 0) {
1606 PyObject *key, *value;
1607 Py_ssize_t pos = 0;
1608 while (PyDict_Next(keywords, &pos, &key, &value)) {
1609 int match = 0;
1610 char *ks;
1611 if (!PyUnicode_Check(key)) {
1612 PyErr_SetString(PyExc_TypeError,
1613 "keywords must be strings");
1614 return cleanreturn(0, freelist);
1615 }
Victor Stinner93b55132010-05-19 00:54:06 +00001616 /* check that _PyUnicode_AsString() result is not NULL */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617 ks = _PyUnicode_AsString(key);
Victor Stinner93b55132010-05-19 00:54:06 +00001618 if (ks != NULL) {
1619 for (i = 0; i < len; i++) {
1620 if (!strcmp(ks, kwlist[i])) {
1621 match = 1;
1622 break;
1623 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 }
1625 }
1626 if (!match) {
1627 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001628 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001630 key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001631 return cleanreturn(0, freelist);
1632 }
1633 }
1634 }
1635
1636 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001637}
1638
1639
1640static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001641skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001642{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 const char *format = *p_format;
1644 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001645
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 /* simple codes
1649 * The individual types (second arg of va_arg) are irrelevant */
Georg Brandl6dd14612005-09-14 19:29:53 +00001650
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001651 case 'b': /* byte -- very short int */
1652 case 'B': /* byte as bitfield */
1653 case 'h': /* short int */
1654 case 'H': /* short int as bitfield */
1655 case 'i': /* int */
1656 case 'I': /* int sized bitfield */
1657 case 'l': /* long int */
1658 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001659#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001660 case 'L': /* PY_LONG_LONG */
1661 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001662#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001663 case 'f': /* float */
1664 case 'd': /* double */
1665 case 'D': /* complex double */
1666 case 'c': /* char */
1667 case 'C': /* unicode char */
1668 {
1669 (void) va_arg(*p_va, void *);
1670 break;
1671 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001672
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 case 'n': /* Py_ssize_t */
1674 {
1675 (void) va_arg(*p_va, Py_ssize_t *);
1676 break;
1677 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001679 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001680
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001681 case 'e': /* string with encoding */
1682 {
1683 (void) va_arg(*p_va, const char *);
1684 if (!(*format == 's' || *format == 't'))
1685 /* after 'e', only 's' and 't' is allowed */
1686 goto err;
1687 format++;
1688 /* explicit fallthrough to string cases */
1689 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001691 case 's': /* string */
1692 case 'z': /* string or None */
1693 case 'y': /* bytes */
1694 case 'u': /* unicode string */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 case 'w': /* buffer, read-write */
1696 {
1697 (void) va_arg(*p_va, char **);
1698 if (*format == '#') {
1699 if (flags & FLAG_SIZE_T)
1700 (void) va_arg(*p_va, Py_ssize_t *);
1701 else
1702 (void) va_arg(*p_va, int *);
1703 format++;
1704 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1705 format++;
1706 }
1707 break;
1708 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001710 /* object codes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001711
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001712 case 'S': /* string object */
1713 case 'Y': /* string object */
1714 case 'U': /* unicode string object */
1715 {
1716 (void) va_arg(*p_va, PyObject **);
1717 break;
1718 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001719
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001720 case 'O': /* object */
1721 {
1722 if (*format == '!') {
1723 format++;
1724 (void) va_arg(*p_va, PyTypeObject*);
1725 (void) va_arg(*p_va, PyObject **);
1726 }
1727 else if (*format == '&') {
1728 typedef int (*converter)(PyObject *, void *);
1729 (void) va_arg(*p_va, converter);
1730 (void) va_arg(*p_va, void *);
1731 format++;
1732 }
1733 else {
1734 (void) va_arg(*p_va, PyObject **);
1735 }
1736 break;
1737 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001739 case '(': /* bypass tuple, not handled at all previously */
1740 {
1741 char *msg;
1742 for (;;) {
1743 if (*format==')')
1744 break;
1745 if (IS_END_OF_FORMAT(*format))
1746 return "Unmatched left paren in format "
1747 "string";
1748 msg = skipitem(&format, p_va, flags);
1749 if (msg)
1750 return msg;
1751 }
1752 format++;
1753 break;
1754 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001755
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001756 case ')':
1757 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00001758
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001759 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001760err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001761 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001762
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001763 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001764
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001765 *p_format = format;
1766 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001767}
Fred Drakee4616e62001-10-23 21:09:29 +00001768
1769
1770int
Martin v. Löwis76246742006-03-01 04:06:10 +00001771PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001772{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001773 Py_ssize_t i, l;
1774 PyObject **o;
1775 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001776
1777#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001778 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001779#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001780 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001781#endif
1782
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001783 assert(min >= 0);
1784 assert(min <= max);
1785 if (!PyTuple_Check(args)) {
1786 PyErr_SetString(PyExc_SystemError,
1787 "PyArg_UnpackTuple() argument list is not a tuple");
1788 return 0;
1789 }
1790 l = PyTuple_GET_SIZE(args);
1791 if (l < min) {
1792 if (name != NULL)
1793 PyErr_Format(
1794 PyExc_TypeError,
1795 "%s expected %s%zd arguments, got %zd",
1796 name, (min == max ? "" : "at least "), min, l);
1797 else
1798 PyErr_Format(
1799 PyExc_TypeError,
1800 "unpacked tuple should have %s%zd elements,"
1801 " but has %zd",
1802 (min == max ? "" : "at least "), min, l);
1803 va_end(vargs);
1804 return 0;
1805 }
1806 if (l > max) {
1807 if (name != NULL)
1808 PyErr_Format(
1809 PyExc_TypeError,
1810 "%s expected %s%zd arguments, got %zd",
1811 name, (min == max ? "" : "at most "), max, l);
1812 else
1813 PyErr_Format(
1814 PyExc_TypeError,
1815 "unpacked tuple should have %s%zd elements,"
1816 " but has %zd",
1817 (min == max ? "" : "at most "), max, l);
1818 va_end(vargs);
1819 return 0;
1820 }
1821 for (i = 0; i < l; i++) {
1822 o = va_arg(vargs, PyObject **);
1823 *o = PyTuple_GET_ITEM(args, i);
1824 }
1825 va_end(vargs);
1826 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001827}
Georg Brandl02c42872005-08-26 06:42:30 +00001828
1829
1830/* For type constructors that don't take keyword args
1831 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001832 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001833 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001834 */
1835int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001836_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001837{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001838 if (kw == NULL)
1839 return 1;
1840 if (!PyDict_CheckExact(kw)) {
1841 PyErr_BadInternalCall();
1842 return 0;
1843 }
1844 if (PyDict_Size(kw) == 0)
1845 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001846
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001847 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1848 funcname);
1849 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001850}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001851#ifdef __cplusplus
1852};
1853#endif