blob: 39be98c03ff8daef961bd4c88656163be8d41a6a [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 *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000017 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000018int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +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,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +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 *,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +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 *,
Martin v. Löwis15e62742006-02-27 16:46:16 +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{
56 int retval;
57 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000058
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000059 va_start(va, format);
Martin v. Löwis18e16552006-02-15 17:27:45 +000060 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
61 va_end(va);
62 return retval;
63}
64
65int
66_PyArg_Parse_SizeT(PyObject *args, char *format, ...)
67{
68 int retval;
69 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000070
Martin v. Löwis18e16552006-02-15 17:27:45 +000071 va_start(va, format);
72 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000073 va_end(va);
74 return retval;
75}
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{
81 int retval;
82 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000083
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000084 va_start(va, format);
Guido van Rossum1ae940a1995-01-02 19:04:15 +000085 retval = vgetargs1(args, format, &va, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000086 va_end(va);
87 return retval;
88}
89
Martin v. Löwis18e16552006-02-15 17:27:45 +000090int
91_PyArg_ParseTuple_SizeT(PyObject *args, char *format, ...)
92{
93 int retval;
94 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000095
Martin v. Löwis18e16552006-02-15 17:27:45 +000096 va_start(va, format);
97 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
98 va_end(va);
99 return retval;
100}
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{
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000106 va_list lva;
107
108#ifdef VA_LIST_IS_ARRAY
109 memcpy(lva, va, sizeof(va_list));
110#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000111#ifdef __va_copy
112 __va_copy(lva, va);
113#else
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000114 lva = va;
115#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000116#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000117
118 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{
124 va_list lva;
125
126#ifdef VA_LIST_IS_ARRAY
127 memcpy(lva, va, sizeof(va_list));
128#else
129#ifdef __va_copy
130 __va_copy(lva, va);
131#else
132 lva = va;
133#endif
134#endif
135
136 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
137}
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{
Benjamin Petersonb173f782009-05-05 22:31:58 +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{
Benjamin Petersonb173f782009-05-05 22:31:58 +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{
167 PyObject *cobj;
Benjamin Petersonb173f782009-05-05 22:31:58 +0000168 const char *name;
169
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000170 if (!*freelist) {
171 *freelist = PyList_New(0);
172 if (!*freelist) {
Antoine Pitrouf71995782008-08-29 18:37:05 +0000173 destr(ptr);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000174 return -1;
175 }
176 }
Benjamin Petersonb173f782009-05-05 22:31:58 +0000177
178 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);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000186 if (!cobj) {
Antoine Pitrouf71995782008-08-29 18:37:05 +0000187 destr(ptr);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000188 return -1;
189 }
Christian Heimes836baa52008-02-26 08:18:30 +0000190 if (PyList_Append(*freelist, cobj)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000191 Py_DECREF(cobj);
192 return -1;
193 }
194 Py_DECREF(cobj);
195 return 0;
196}
197
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000198static void
199cleanup_convert(PyObject *self)
200{
201 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);
207}
208
209static int
210addcleanup_convert(void *ptr, PyObject **freelist, int (*destr)(PyObject*,void*))
211{
212 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;
236}
237
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000238static int
239cleanreturn(int retval, PyObject *freelist)
240{
Antoine Pitrouf71995782008-08-29 18:37:05 +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++)
Benjamin Petersonb173f782009-05-05 22:31:58 +0000246 PyCapsule_SetDestructor(PyList_GET_ITEM(freelist, i), NULL);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000247 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000248 Py_XDECREF(freelist);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000249 return retval;
250}
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{
256 char msgbuf[256];
257 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000258 const char *fname = NULL;
259 const char *message = NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000260 int min = -1;
261 int max = 0;
262 int level = 0;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000263 int endfmt = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000264 const char *formatsave = format;
Martin v. Löwisd96ee902006-02-16 14:37:16 +0000265 Py_ssize_t i, len;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000266 char *msg;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000267 PyObject *freelist = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000268 int compat = flags & FLAG_COMPAT;
269
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000270 assert(compat || (args != (PyObject*)NULL));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000271 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000272
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000273 while (endfmt == 0) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000274 int c = *format++;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000275 switch (c) {
276 case '(':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000277 if (level == 0)
278 max++;
279 level++;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000280 if (level >= 30)
281 Py_FatalError("too many tuple nesting levels "
282 "in argument format string");
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000283 break;
284 case ')':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000285 if (level == 0)
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000286 Py_FatalError("excess ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000287 else
288 level--;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000289 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000290 case '\0':
291 endfmt = 1;
292 break;
293 case ':':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000294 fname = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000295 endfmt = 1;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000296 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000297 case ';':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000298 message = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000299 endfmt = 1;
300 break;
301 default:
302 if (level == 0) {
303 if (c == 'O')
304 max++;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000305 else if (isalpha(Py_CHARMASK(c))) {
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000306 if (c != 'e') /* skip encoded */
307 max++;
308 } else if (c == '|')
309 min = max;
310 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000311 break;
312 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000313 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000314
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000315 if (level != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000316 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000317
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000318 if (min < 0)
319 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000320
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000321 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000322
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000323 if (compat) {
324 if (max == 0) {
325 if (args == NULL)
326 return 1;
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000327 PyOS_snprintf(msgbuf, sizeof(msgbuf),
328 "%.200s%s takes no arguments",
329 fname==NULL ? "function" : fname,
330 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000331 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000332 return 0;
333 }
334 else if (min == 1 && max == 1) {
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000335 if (args == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000336 PyOS_snprintf(msgbuf, sizeof(msgbuf),
337 "%.200s%s takes at least one argument",
338 fname==NULL ? "function" : fname,
339 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000340 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000341 return 0;
342 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000343 msg = convertitem(args, &format, p_va, flags, levels,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000344 msgbuf, sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000345 if (msg == NULL)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000346 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000347 seterror(levels[0], msg, levels+1, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000348 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000349 }
350 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000351 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000352 "old style getargs format uses new features");
353 return 0;
354 }
355 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000356
Guido van Rossum79f25d91997-04-29 20:08:16 +0000357 if (!PyTuple_Check(args)) {
358 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000359 "new style getargs format but argument is not a tuple");
360 return 0;
361 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000362
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000363 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000364
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000365 if (len < min || max < len) {
366 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000367 PyOS_snprintf(msgbuf, sizeof(msgbuf),
368 "%.150s%s takes %s %d argument%s "
Neal Norwitz20dd93f2006-02-19 19:34:15 +0000369 "(%ld given)",
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000370 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",
Neal Norwitz9a276172006-02-20 18:57:39 +0000376 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000377 message = msgbuf;
378 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000379 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000380 return 0;
381 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000382
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000383 for (i = 0; i < len; i++) {
384 if (*format == '|')
385 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000386 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000387 flags, levels, msgbuf,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000388 sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000389 if (msg) {
Sean Reifscheider642d96a2009-08-01 23:55:06 +0000390 seterror(i+1, msg, levels, fname, msg);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000391 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000392 }
393 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000394
Neal Norwitz4ac13df2005-12-19 06:10:07 +0000395 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
Guido van Rossum7d4f68c1997-12-19 04:25:23 +0000396 *format != '(' &&
Guido van Rossum231a41e1997-12-09 20:36:39 +0000397 *format != '|' && *format != ':' && *format != ';') {
398 PyErr_Format(PyExc_SystemError,
Guido van Rossum0d6b49e1998-01-19 22:22:44 +0000399 "bad format string: %.200s", formatsave);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000400 return cleanreturn(0, freelist);
Guido van Rossum231a41e1997-12-09 20:36:39 +0000401 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000402
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +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{
Marc-André Lemburgd4c0a9c2001-11-28 11:47:00 +0000412 char buf[512];
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000413 int i;
414 char *p = buf;
415
Guido van Rossum79f25d91997-04-29 20:08:16 +0000416 if (PyErr_Occurred())
Guido van Rossum64fc6491995-01-21 14:09:37 +0000417 return;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000418 else if (message == NULL) {
419 if (fname != NULL) {
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000420 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000421 p += strlen(p);
422 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000423 if (iarg != 0) {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000424 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000425 "argument %d", iarg);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000426 i = 0;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000427 p += strlen(p);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000428 while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
429 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000430 ", item %d", levels[i]-1);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000431 p += strlen(p);
432 i++;
433 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000434 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000435 else {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000436 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
Ka-Ping Yee20579702001-01-15 22:14:16 +0000437 p += strlen(p);
438 }
Tim Petersfaad5ad2001-12-03 00:43:33 +0000439 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000440 message = buf;
441 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000442 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:
Ka-Ping Yee20579702001-01-15 22:14:16 +0000458 "must be <typename1>, not <typename2>", where:
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000459 <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{
469 int level = 0;
470 int n = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000471 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000472 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000473
Guido van Rossumfe3f1a21994-09-29 09:42:55 +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;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000488 else if (level == 0 && isalpha(Py_CHARMASK(c)))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000489 n++;
490 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000491
Christian Heimes72b710a2008-05-26 13:28:38 +0000492 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000493 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000494 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000495 toplevel ? "expected %d arguments, not %.50s" :
496 "must be %d-item sequence, not %.50s",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000497 n,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000498 arg == Py_None ? "None" : arg->ob_type->tp_name);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000499 return msgbuf;
500 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000501
Jeremy Hylton03657cf2000-07-12 13:05:33 +0000502 if ((i = PySequence_Size(arg)) != n) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000503 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000504 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000505 toplevel ? "expected %d arguments, not %d" :
506 "must be sequence of length %d, not %d",
507 n, i);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000508 return msgbuf;
509 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000510
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000511 format = *p_format;
512 for (i = 0; i < n; i++) {
513 char *msg;
Guido van Rossum66368cc1999-02-17 23:16:43 +0000514 PyObject *item;
515 item = PySequence_GetItem(arg, i);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000516 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 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000523 msg = convertitem(item, &format, p_va, flags, levels+1,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000524 msgbuf, bufsize, freelist);
Guido van Rossum66368cc1999-02-17 23:16:43 +0000525 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
526 Py_XDECREF(item);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000527 if (msg != NULL) {
528 levels[0] = i+1;
529 return msg;
530 }
531 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000532
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000533 *p_format = format;
534 return NULL;
535}
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{
544 char *msg;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000545 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000546
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000547 if (*format == '(' /* ')' */) {
548 format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000549 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000550 bufsize, 0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000551 if (msg == NULL)
552 format++;
553 }
554 else {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000555 msg = convertsimple(arg, &format, p_va, flags,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000556 msgbuf, bufsize, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000557 if (msg != NULL)
558 levels[0] = 0;
559 }
560 if (msg == NULL)
561 *p_format = format;
562 return msg;
563}
564
565
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000566
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000567#define UNICODE_DEFAULT_ENCODING(arg) \
568 _PyUnicode_AsDefaultEncodedString(arg, NULL)
569
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{
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000575 assert(expected != NULL);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000576 assert(arg != NULL);
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000577 PyOS_snprintf(msgbuf, bufsize,
578 "must be %.50s, not %.50s", expected,
579 arg == Py_None ? "None" : arg->ob_type->tp_name);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000580 return msgbuf;
581}
582
583#define CONV_UNICODE "(unicode conversion error)"
584
Mark Dickinsonde604012010-01-01 19:27:32 +0000585/* explicitly check for float arguments when integers are expected. For now
586 * signal a warning. Returns true if an exception was raised. */
587static int
588float_argument_warning(PyObject *arg)
589{
590 if (PyFloat_Check(arg) &&
591 PyErr_Warn(PyExc_DeprecationWarning,
592 "integer argument expected, got float" ))
593 return 1;
594 else
595 return 0;
596}
597
Guido van Rossum45aecf42006-03-15 04:58:47 +0000598/* Explicitly check for float arguments when integers are expected.
599 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000600static int
601float_argument_error(PyObject *arg)
602{
Guido van Rossum45aecf42006-03-15 04:58:47 +0000603 if (PyFloat_Check(arg)) {
604 PyErr_SetString(PyExc_TypeError,
605 "integer argument expected, got float" );
Neil Schemenauer5042da62003-02-04 20:59:40 +0000606 return 1;
Guido van Rossum45aecf42006-03-15 04:58:47 +0000607 }
Neil Schemenauer5042da62003-02-04 20:59:40 +0000608 else
609 return 0;
610}
611
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000612/* Convert a non-tuple argument. Return NULL if conversion went OK,
613 or a string with a message describing the failure. The message is
614 formatted as "must be <desired type>, not <actual type>".
615 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000616 Don't call if a tuple is expected.
617
618 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000619*/
620
621static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000622convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000623 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000624{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000625 /* For # codes */
626#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
627 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
628 else q=va_arg(*p_va, int*);
629#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
630#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
631
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000632 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000633 char c = *format++;
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000634 PyObject *uarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000635
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000636 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000637
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000638 case 'b': { /* unsigned byte -- very short int */
639 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000640 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000641 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000642 return converterr("integer<b>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000643 ival = PyLong_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000644 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000645 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000646 else if (ival < 0) {
647 PyErr_SetString(PyExc_OverflowError,
648 "unsigned byte integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000649 return converterr("integer<b>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000650 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000651 else if (ival > UCHAR_MAX) {
652 PyErr_SetString(PyExc_OverflowError,
653 "unsigned byte integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000654 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000655 }
656 else
657 *p = (unsigned char) ival;
658 break;
659 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000660
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000661 case 'B': {/* byte sized bitfield - both signed and unsigned
Guido van Rossum98297ee2007-11-06 21:34:58 +0000662 values allowed */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000663 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000664 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000665 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000666 return converterr("integer<B>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000667 ival = PyLong_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000668 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000669 return converterr("integer<B>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000670 else
671 *p = (unsigned char) ival;
672 break;
673 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000674
Guido van Rossumfce26e72003-04-18 00:12:30 +0000675 case 'h': {/* signed short int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000676 short *p = va_arg(*p_va, short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000677 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000678 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000679 return converterr("integer<h>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000680 ival = PyLong_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000681 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000682 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfce26e72003-04-18 00:12:30 +0000683 else if (ival < SHRT_MIN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000684 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000685 "signed short integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000686 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000687 }
Guido van Rossumfce26e72003-04-18 00:12:30 +0000688 else if (ival > SHRT_MAX) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000689 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000690 "signed short integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000691 return converterr("integer<h>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000692 }
693 else
694 *p = (short) ival;
695 break;
696 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000697
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000698 case 'H': { /* short int sized bitfield, both signed and
Guido van Rossum98297ee2007-11-06 21:34:58 +0000699 unsigned allowed */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000700 unsigned short *p = va_arg(*p_va, unsigned short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000701 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000702 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000703 return converterr("integer<H>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000704 ival = PyLong_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000705 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000706 return converterr("integer<H>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000707 else
708 *p = (unsigned short) ival;
709 break;
710 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000711
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000712 case 'i': {/* signed int */
713 int *p = va_arg(*p_va, int *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000714 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000715 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000716 return converterr("integer<i>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000717 ival = PyLong_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000718 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000719 return converterr("integer<i>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000720 else if (ival > INT_MAX) {
721 PyErr_SetString(PyExc_OverflowError,
722 "signed integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000723 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000724 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000725 else if (ival < INT_MIN) {
726 PyErr_SetString(PyExc_OverflowError,
727 "signed integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000728 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000729 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000730 else
731 *p = ival;
732 break;
733 }
734
Thomas Hellera4ea6032003-04-17 18:55:45 +0000735 case 'I': { /* int sized bitfield, both signed and
Guido van Rossum98297ee2007-11-06 21:34:58 +0000736 unsigned allowed */
Thomas Hellera4ea6032003-04-17 18:55:45 +0000737 unsigned int *p = va_arg(*p_va, unsigned int *);
738 unsigned int ival;
739 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000740 return converterr("integer<I>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000741 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000742 if (ival == (unsigned int)-1 && PyErr_Occurred())
Thomas Hellera4ea6032003-04-17 18:55:45 +0000743 return converterr("integer<I>", arg, msgbuf, bufsize);
744 else
745 *p = ival;
746 break;
747 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000748
Martin v. Löwis18e16552006-02-15 17:27:45 +0000749 case 'n': /* Py_ssize_t */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000750 {
Neal Norwitzb879f572007-08-31 05:20:36 +0000751 PyObject *iobj;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000752 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
Neal Norwitzb879f572007-08-31 05:20:36 +0000753 Py_ssize_t ival = -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000754 if (float_argument_error(arg))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000755 return converterr("integer<n>", arg, msgbuf, bufsize);
Neal Norwitzb879f572007-08-31 05:20:36 +0000756 iobj = PyNumber_Index(arg);
Christian Heimesbcd2c082008-05-08 01:20:25 +0000757 if (iobj != NULL) {
Trent Nelson35133582008-04-22 19:02:40 +0000758 ival = PyLong_AsSsize_t(iobj);
Christian Heimesbcd2c082008-05-08 01:20:25 +0000759 Py_DECREF(iobj);
760 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000761 if (ival == -1 && PyErr_Occurred())
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000762 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000763 *p = ival;
764 break;
765 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000766 case 'l': {/* long int */
767 long *p = va_arg(*p_va, long *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000768 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000769 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000770 return converterr("integer<l>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000771 ival = PyLong_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000772 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000773 return converterr("integer<l>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000774 else
775 *p = ival;
776 break;
777 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000778
779 case 'k': { /* long sized bitfield */
780 unsigned long *p = va_arg(*p_va, unsigned long *);
781 unsigned long ival;
Georg Brandle1a0d112007-10-23 19:24:22 +0000782 if (PyLong_Check(arg))
Thomas Hellera4ea6032003-04-17 18:55:45 +0000783 ival = PyLong_AsUnsignedLongMask(arg);
784 else
785 return converterr("integer<k>", arg, msgbuf, bufsize);
786 *p = ival;
787 break;
788 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000789
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000790#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000791 case 'L': {/* PY_LONG_LONG */
792 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
Mark Dickinsonde604012010-01-01 19:27:32 +0000793 PY_LONG_LONG ival;
794 if (float_argument_warning(arg))
795 return converterr("long<L>", arg, msgbuf, bufsize);
796 ival = PyLong_AsLongLong(arg);
Christian Heimes836baa52008-02-26 08:18:30 +0000797 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000798 return converterr("long<L>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000799 } else {
800 *p = ival;
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000801 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000802 break;
803 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000804
805 case 'K': { /* long long sized bitfield */
806 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
807 unsigned PY_LONG_LONG ival;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000808 if (PyLong_Check(arg))
Thomas Hellera4ea6032003-04-17 18:55:45 +0000809 ival = PyLong_AsUnsignedLongLongMask(arg);
810 else
811 return converterr("integer<K>", arg, msgbuf, bufsize);
812 *p = ival;
813 break;
814 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000815#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000816
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000817 case 'f': {/* float */
818 float *p = va_arg(*p_va, float *);
819 double dval = PyFloat_AsDouble(arg);
820 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000821 return converterr("float<f>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000822 else
823 *p = (float) dval;
824 break;
825 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000826
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000827 case 'd': {/* double */
828 double *p = va_arg(*p_va, double *);
829 double dval = PyFloat_AsDouble(arg);
830 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000831 return converterr("float<d>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000832 else
833 *p = dval;
834 break;
835 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000836
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000837 case 'D': {/* complex double */
838 Py_complex *p = va_arg(*p_va, Py_complex *);
839 Py_complex cval;
840 cval = PyComplex_AsCComplex(arg);
841 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000842 return converterr("complex<D>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000843 else
844 *p = cval;
845 break;
846 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000847
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000848 case 'c': {/* char */
Walter Dörwaldd0941302007-07-01 21:58:22 +0000849 char *p = va_arg(*p_va, char *);
Christian Heimes72b710a2008-05-26 13:28:38 +0000850 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
851 *p = PyBytes_AS_STRING(arg)[0];
Walter Dörwaldd0941302007-07-01 21:58:22 +0000852 else
Benjamin Peterson7fe98532009-04-02 00:33:55 +0000853 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
Walter Dörwaldd0941302007-07-01 21:58:22 +0000854 break;
855 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000856
Walter Dörwaldd0941302007-07-01 21:58:22 +0000857 case 'C': {/* unicode char */
Walter Dörwaldbc1f8862007-06-20 11:02:38 +0000858 int *p = va_arg(*p_va, int *);
Benjamin Peterson7fe98532009-04-02 00:33:55 +0000859 if (PyUnicode_Check(arg) &&
860 PyUnicode_GET_SIZE(arg) == 1)
Guido van Rossum09dc34f2007-05-04 04:17:33 +0000861 *p = PyUnicode_AS_UNICODE(arg)[0];
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000862 else
Benjamin Peterson7fe98532009-04-02 00:33:55 +0000863 return converterr("a unicode character", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000864 break;
865 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000866
867 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w', 't' codes all
868 need to be cleaned up! */
869
870 case 's': {/* text string */
Martin v. Löwis423be952008-08-13 15:53:07 +0000871 if (*format == '*') {
872 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
873
874 if (PyUnicode_Check(arg)) {
875 uarg = UNICODE_DEFAULT_ENCODING(arg);
876 if (uarg == NULL)
877 return converterr(CONV_UNICODE,
878 arg, msgbuf, bufsize);
879 PyBuffer_FillInfo(p, arg,
880 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
881 1, 0);
882 }
883 else { /* any buffer-like object */
884 char *buf;
885 if (getbuffer(arg, p, &buf) < 0)
886 return converterr(buf, arg, msgbuf, bufsize);
887 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000888 if (addcleanup(p, freelist, cleanup_buffer)) {
889 return converterr(
890 "(cleanup problem)",
891 arg, msgbuf, bufsize);
892 }
Martin v. Löwis423be952008-08-13 15:53:07 +0000893 format++;
894 } else if (*format == '#') {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000895 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000896 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000897
898 if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000899 uarg = UNICODE_DEFAULT_ENCODING(arg);
900 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000901 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000902 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000903 *p = PyBytes_AS_STRING(uarg);
904 STORE_SIZE(PyBytes_GET_SIZE(uarg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000905 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000906 else { /* any buffer-like object */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000907 /* XXX Really? */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000908 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000909 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000910 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000911 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000912 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000913 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000914 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000915 } else {
916 char **p = va_arg(*p_va, char **);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000917
918 if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000919 uarg = UNICODE_DEFAULT_ENCODING(arg);
920 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000921 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000922 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000923 *p = PyBytes_AS_STRING(uarg);
Marc-André Lemburg6f15e572001-05-02 17:16:16 +0000924 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000925 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000926 return converterr("string", arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000927 if ((Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000928 return converterr("string without null bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000929 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000930 }
931 break;
932 }
933
Guido van Rossum98297ee2007-11-06 21:34:58 +0000934 case 'y': {/* any buffer-like object, but not PyUnicode */
935 void **p = (void **)va_arg(*p_va, char **);
936 char *buf;
Martin v. Löwis423be952008-08-13 15:53:07 +0000937 Py_ssize_t count;
938 if (*format == '*') {
939 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
940 return converterr(buf, arg, msgbuf, bufsize);
941 format++;
Antoine Pitrouf71995782008-08-29 18:37:05 +0000942 if (addcleanup(p, freelist, cleanup_buffer)) {
943 return converterr(
944 "(cleanup problem)",
945 arg, msgbuf, bufsize);
946 }
Martin v. Löwis423be952008-08-13 15:53:07 +0000947 break;
948 }
949 count = convertbuffer(arg, p, &buf);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000950 if (count < 0)
951 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis423be952008-08-13 15:53:07 +0000952 else if (*format == '#') {
Walter Dörwald612344f2007-05-04 19:28:21 +0000953 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000954 STORE_SIZE(count);
Walter Dörwald612344f2007-05-04 19:28:21 +0000955 format++;
Walter Dörwald612344f2007-05-04 19:28:21 +0000956 }
957 break;
958 }
959
Guido van Rossum98297ee2007-11-06 21:34:58 +0000960 case 'z': {/* like 's' or 's#', but None is okay, stored as NULL */
Martin v. Löwis423be952008-08-13 15:53:07 +0000961 if (*format == '*') {
962 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
963
964 if (arg == Py_None)
965 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
966 else if (PyUnicode_Check(arg)) {
967 uarg = UNICODE_DEFAULT_ENCODING(arg);
968 if (uarg == NULL)
969 return converterr(CONV_UNICODE,
970 arg, msgbuf, bufsize);
971 PyBuffer_FillInfo(p, arg,
972 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
973 1, 0);
974 }
975 else { /* any buffer-like object */
976 char *buf;
977 if (getbuffer(arg, p, &buf) < 0)
978 return converterr(buf, arg, msgbuf, bufsize);
979 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000980 if (addcleanup(p, freelist, cleanup_buffer)) {
981 return converterr(
982 "(cleanup problem)",
983 arg, msgbuf, bufsize);
984 }
Martin v. Löwis423be952008-08-13 15:53:07 +0000985 format++;
986 } else if (*format == '#') { /* any buffer-like object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000987 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000988 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000989
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000990 if (arg == Py_None) {
991 *p = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000992 STORE_SIZE(0);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000993 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000994 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000995 uarg = UNICODE_DEFAULT_ENCODING(arg);
996 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000997 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000998 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000999 *p = PyBytes_AS_STRING(uarg);
1000 STORE_SIZE(PyBytes_GET_SIZE(uarg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001001 }
1002 else { /* any buffer-like object */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001003 /* XXX Really? */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001004 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001005 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001006 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001007 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001008 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001009 }
1010 format++;
1011 } else {
1012 char **p = va_arg(*p_va, char **);
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +00001013 uarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001014
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001015 if (arg == Py_None)
1016 *p = 0;
Christian Heimes72b710a2008-05-26 13:28:38 +00001017 else if (PyBytes_Check(arg)) {
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +00001018 /* Enable null byte check below */
1019 uarg = arg;
Christian Heimes72b710a2008-05-26 13:28:38 +00001020 *p = PyBytes_AS_STRING(arg);
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +00001021 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001022 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +00001023 uarg = UNICODE_DEFAULT_ENCODING(arg);
1024 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001025 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001026 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +00001027 *p = PyBytes_AS_STRING(uarg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001028 }
1029 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001030 return converterr("string or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001031 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001032 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001033 FETCH_SIZE;
Thomas Woutersc3547a32006-03-01 21:31:21 +00001034 assert(0); /* XXX redundant with if-case */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001035 if (arg == Py_None) {
1036 STORE_SIZE(0);
1037 }
1038 else {
Christian Heimes72b710a2008-05-26 13:28:38 +00001039 STORE_SIZE(PyBytes_Size(arg));
Guido van Rossum98297ee2007-11-06 21:34:58 +00001040 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001041 format++;
1042 }
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +00001043 else if (*p != NULL && uarg != NULL &&
Christian Heimes72b710a2008-05-26 13:28:38 +00001044 (Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001045 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001046 "string without null bytes or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001047 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001048 }
1049 break;
1050 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001051
Guido van Rossumfb67be22007-08-29 18:38:11 +00001052 case 'Z': {/* unicode, may be NULL (None) */
1053 if (*format == '#') { /* any buffer-like object */
1054 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1055 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001056
Guido van Rossumfb67be22007-08-29 18:38:11 +00001057 if (arg == Py_None) {
1058 *p = 0;
1059 STORE_SIZE(0);
1060 }
1061 else if (PyUnicode_Check(arg)) {
1062 *p = PyUnicode_AS_UNICODE(arg);
1063 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1064 }
1065 format++;
1066 } else {
1067 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001068
Guido van Rossumfb67be22007-08-29 18:38:11 +00001069 if (arg == Py_None)
1070 *p = 0;
1071 else if (PyUnicode_Check(arg))
1072 *p = PyUnicode_AS_UNICODE(arg);
1073 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001074 return converterr("string or None",
Guido van Rossumfb67be22007-08-29 18:38:11 +00001075 arg, msgbuf, bufsize);
1076 }
1077 break;
1078 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001079
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001080 case 'e': {/* encoded string */
1081 char **buffer;
1082 const char *encoding;
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001083 PyObject *s;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001084 int recode_strings;
1085 Py_ssize_t size;
Guido van Rossumd70539a2007-05-09 23:35:09 +00001086 const char *ptr;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001087
1088 /* Get 'e' parameter: the encoding name */
1089 encoding = (const char *)va_arg(*p_va, const char *);
1090 if (encoding == NULL)
1091 encoding = PyUnicode_GetDefaultEncoding();
Guido van Rossum98297ee2007-11-06 21:34:58 +00001092
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001093 /* Get output buffer parameter:
1094 's' (recode all objects via Unicode) or
Guido van Rossum98297ee2007-11-06 21:34:58 +00001095 't' (only recode non-string objects)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001096 */
1097 if (*format == 's')
1098 recode_strings = 1;
1099 else if (*format == 't')
1100 recode_strings = 0;
1101 else
1102 return converterr(
1103 "(unknown parser marker combination)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001104 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001105 buffer = (char **)va_arg(*p_va, char **);
1106 format++;
1107 if (buffer == NULL)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001108 return converterr("(buffer is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001109 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001110
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001111 /* Encode object */
Guido van Rossumd70539a2007-05-09 23:35:09 +00001112 if (!recode_strings &&
Christian Heimes72b710a2008-05-26 13:28:38 +00001113 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001114 s = arg;
1115 Py_INCREF(s);
Guido van Rossumd70539a2007-05-09 23:35:09 +00001116 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1117 return converterr("(AsCharBuffer failed)",
1118 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001119 }
1120 else {
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001121 PyObject *u;
1122
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001123 /* Convert object to Unicode */
1124 u = PyUnicode_FromObject(arg);
1125 if (u == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001126 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001127 "string or unicode or text buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001128 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001129
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001130 /* Encode object; use default error handling */
1131 s = PyUnicode_AsEncodedString(u,
1132 encoding,
1133 NULL);
1134 Py_DECREF(u);
1135 if (s == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001136 return converterr("(encoding failed)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001137 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +00001138 if (!PyBytes_Check(s)) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001139 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001140 return converterr(
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001141 "(encoder failed to return bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001142 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001143 }
Christian Heimes72b710a2008-05-26 13:28:38 +00001144 size = PyBytes_GET_SIZE(s);
1145 ptr = PyBytes_AS_STRING(s);
Guido van Rossumd70539a2007-05-09 23:35:09 +00001146 if (ptr == NULL)
1147 ptr = "";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001148 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001149
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001150 /* Write output; output is guaranteed to be 0-terminated */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001151 if (*format == '#') {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001152 /* Using buffer length parameter '#':
Guido van Rossum98297ee2007-11-06 21:34:58 +00001153
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001154 - if *buffer is NULL, a new buffer of the
1155 needed size is allocated and the data
1156 copied into it; *buffer is updated to point
1157 to the new buffer; the caller is
1158 responsible for PyMem_Free()ing it after
Guido van Rossum98297ee2007-11-06 21:34:58 +00001159 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001160
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001161 - if *buffer is not NULL, the data is
1162 copied to *buffer; *buffer_len has to be
1163 set to the size of the buffer on input;
1164 buffer overflow is signalled with an error;
1165 buffer has to provide enough room for the
1166 encoded string plus the trailing 0-byte
Guido van Rossum98297ee2007-11-06 21:34:58 +00001167
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001168 - in both cases, *buffer_len is updated to
1169 the size of the buffer /excluding/ the
Guido van Rossum98297ee2007-11-06 21:34:58 +00001170 trailing 0-byte
1171
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001172 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001173 FETCH_SIZE;
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001174
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001175 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001176 if (q == NULL && q2 == NULL) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001177 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001178 return converterr(
1179 "(buffer_len is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001180 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001181 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001182 if (*buffer == NULL) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001183 *buffer = PyMem_NEW(char, size + 1);
1184 if (*buffer == NULL) {
1185 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001186 return converterr(
1187 "(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001188 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001189 }
Antoine Pitrouf71995782008-08-29 18:37:05 +00001190 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001191 Py_DECREF(s);
1192 return converterr(
1193 "(cleanup problem)",
1194 arg, msgbuf, bufsize);
1195 }
Fred Drake25871c02000-05-03 15:17:02 +00001196 } else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001197 if (size + 1 > BUFFER_LEN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001198 Py_DECREF(s);
1199 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001200 "(buffer overflow)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001201 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001202 }
Fred Drake25871c02000-05-03 15:17:02 +00001203 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001204 memcpy(*buffer, ptr, size+1);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001205 STORE_SIZE(size);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001206 } else {
1207 /* Using a 0-terminated buffer:
Guido van Rossum98297ee2007-11-06 21:34:58 +00001208
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001209 - the encoded string has to be 0-terminated
1210 for this variant to work; if it is not, an
Guido van Rossum98297ee2007-11-06 21:34:58 +00001211 error raised
Fred Drake25871c02000-05-03 15:17:02 +00001212
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001213 - a new buffer of the needed size is
1214 allocated and the data copied into it;
1215 *buffer is updated to point to the new
1216 buffer; the caller is responsible for
1217 PyMem_Free()ing it after usage
1218
1219 */
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001220 if ((Py_ssize_t)strlen(ptr) != size) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001221 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001222 return converterr(
Benjamin Petersonef3e4c22009-04-11 19:48:14 +00001223 "encoded string without NULL bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001224 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001225 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001226 *buffer = PyMem_NEW(char, size + 1);
1227 if (*buffer == NULL) {
1228 Py_DECREF(s);
1229 return converterr("(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001230 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001231 }
Antoine Pitrouf71995782008-08-29 18:37:05 +00001232 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001233 Py_DECREF(s);
1234 return converterr("(cleanup problem)",
1235 arg, msgbuf, bufsize);
1236 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001237 memcpy(*buffer, ptr, size+1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001238 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001239 Py_DECREF(s);
1240 break;
1241 }
1242
1243 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001244 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1245 if (!PyUnicode_Check(arg))
1246 return converterr("str", arg, msgbuf, bufsize);
1247 *p = PyUnicode_AS_UNICODE(arg);
1248 if (*format == '#') { /* store pointer and size */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001249 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001250 STORE_SIZE(PyUnicode_GET_SIZE(arg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001251 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001252 }
1253 break;
1254 }
1255
Christian Heimes72b710a2008-05-26 13:28:38 +00001256 case 'S': { /* PyBytes object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001257 PyObject **p = va_arg(*p_va, PyObject **);
Christian Heimes72b710a2008-05-26 13:28:38 +00001258 if (PyBytes_Check(arg))
Guido van Rossum617dbc42007-05-07 23:57:08 +00001259 *p = arg;
1260 else
1261 return converterr("bytes", arg, msgbuf, bufsize);
1262 break;
1263 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001264
Christian Heimes9c4756e2008-05-26 13:22:05 +00001265 case 'Y': { /* PyByteArray object */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001266 PyObject **p = va_arg(*p_va, PyObject **);
Christian Heimes9c4756e2008-05-26 13:22:05 +00001267 if (PyByteArray_Check(arg))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001268 *p = arg;
1269 else
1270 return converterr("buffer", arg, msgbuf, bufsize);
1271 break;
1272 }
1273
1274 case 'U': { /* PyUnicode object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001275 PyObject **p = va_arg(*p_va, PyObject **);
1276 if (PyUnicode_Check(arg))
1277 *p = arg;
1278 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001279 return converterr("str", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001280 break;
1281 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001282
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001283 case 'O': { /* object */
1284 PyTypeObject *type;
1285 PyObject **p;
1286 if (*format == '!') {
1287 type = va_arg(*p_va, PyTypeObject*);
1288 p = va_arg(*p_va, PyObject **);
1289 format++;
Guido van Rossumcbfc8552001-08-28 16:37:51 +00001290 if (PyType_IsSubtype(arg->ob_type, type))
Guido van Rossume826ef02000-03-10 23:02:17 +00001291 *p = arg;
1292 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001293 return converterr(type->tp_name, arg, msgbuf, bufsize);
Guido van Rossumfccfe891998-05-15 22:04:07 +00001294
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001295 }
1296 else if (*format == '?') {
1297 inquiry pred = va_arg(*p_va, inquiry);
1298 p = va_arg(*p_va, PyObject **);
1299 format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001300 if ((*pred)(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001301 *p = arg;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001302 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001303 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001304 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001305
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001306 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001307 else if (*format == '&') {
1308 typedef int (*converter)(PyObject *, void *);
1309 converter convert = va_arg(*p_va, converter);
1310 void *addr = va_arg(*p_va, void *);
Martin v. Löwisc15bdef2009-05-29 14:47:46 +00001311 int res;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001312 format++;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +00001313 if (! (res = (*convert)(arg, addr)))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001314 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001315 arg, msgbuf, bufsize);
Martin v. Löwisc15bdef2009-05-29 14:47:46 +00001316 if (res == Py_CLEANUP_SUPPORTED &&
1317 addcleanup_convert(addr, freelist, convert) == -1)
1318 return converterr("(cleanup problem)",
1319 arg, msgbuf, bufsize);
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001320 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001321 else {
1322 p = va_arg(*p_va, PyObject **);
1323 *p = arg;
1324 }
1325 break;
1326 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001327
1328
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001329 case 'w': { /* memory buffer, read-write access */
1330 void **p = va_arg(*p_va, void **);
1331 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Christian Heimes4e30a842007-11-30 22:12:06 +00001332 Py_ssize_t count;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001333 int temp=-1;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001334 Py_buffer view;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001335
Martin v. Löwis423be952008-08-13 15:53:07 +00001336 if (pb && pb->bf_releasebuffer && *format != '*')
1337 /* Buffer must be released, yet caller does not use
1338 the Py_buffer protocol. */
1339 return converterr("pinned buffer", arg, msgbuf, bufsize);
1340
1341
1342 if (pb && pb->bf_getbuffer && *format == '*') {
1343 /* Caller is interested in Py_buffer, and the object
1344 supports it directly. */
1345 format++;
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001346 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
Martin v. Löwis423be952008-08-13 15:53:07 +00001347 PyErr_Clear();
1348 return converterr("read-write buffer", arg, msgbuf, bufsize);
1349 }
Antoine Pitrouf71995782008-08-29 18:37:05 +00001350 if (addcleanup(p, freelist, cleanup_buffer)) {
1351 return converterr(
1352 "(cleanup problem)",
1353 arg, msgbuf, bufsize);
1354 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001355 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C'))
1356 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1357 break;
1358 }
1359
1360 /* Here we have processed w*, only w and w# remain. */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001361 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001362 pb->bf_getbuffer == NULL ||
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001363 ((temp = PyObject_GetBuffer(arg, &view,
1364 PyBUF_SIMPLE)) != 0) ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001365 view.readonly == 1) {
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001366 if (temp==0) {
1367 PyBuffer_Release(&view);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001368 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001369 return converterr("single-segment read-write buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001370 arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001371 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001372
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001373 if ((count = view.len) < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001374 return converterr("(unspecified)", arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001375 *p = view.buf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001376 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001377 FETCH_SIZE;
1378 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001379 format++;
1380 }
1381 break;
1382 }
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001383
1384 /*TEO: This can be eliminated --- here only for backward
1385 compatibility */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001386 case 't': { /* 8-bit character buffer, read-only access */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001387 char **p = va_arg(*p_va, char **);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001388 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Christian Heimes4e30a842007-11-30 22:12:06 +00001389 Py_ssize_t count;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001390 Py_buffer view;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001391
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001392 if (*format++ != '#')
1393 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001394 "invalid use of 't' format character",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001395 arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001396 if (pb == NULL || pb->bf_getbuffer == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001397 return converterr(
Alexandre Vassalotti70a23712007-10-14 02:05:51 +00001398 "bytes or read-only character buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001399 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001400
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001401 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001402 return converterr("string or single-segment read-only buffer",
1403 arg, msgbuf, bufsize);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001404
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001405 count = view.len;
1406 *p = view.buf;
Martin v. Löwis423be952008-08-13 15:53:07 +00001407 if (pb->bf_releasebuffer)
1408 return converterr(
1409 "string or pinned buffer",
1410 arg, msgbuf, bufsize);
1411
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001412 PyBuffer_Release(&view);
1413
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001414 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001415 return converterr("(unspecified)", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001416 {
1417 FETCH_SIZE;
1418 STORE_SIZE(count);
1419 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001420 break;
1421 }
1422
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001423 default:
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001424 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001425
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001426 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001427
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001428 *p_format = format;
1429 return NULL;
1430}
Guido van Rossumaa354651996-08-19 19:32:04 +00001431
Martin v. Löwis18e16552006-02-15 17:27:45 +00001432static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001433convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001434{
1435 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001436 Py_ssize_t count;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001437 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001438
1439 *errmsg = NULL;
1440 *p = NULL;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001441 if (pb == NULL ||
Martin v. Löwis423be952008-08-13 15:53:07 +00001442 pb->bf_getbuffer == NULL ||
1443 pb->bf_releasebuffer != NULL) {
Guido van Rossumb0834002007-11-21 21:53:51 +00001444 *errmsg = "bytes or read-only buffer";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001445 return -1;
1446 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001447
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001448 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0) {
Guido van Rossumb0834002007-11-21 21:53:51 +00001449 *errmsg = "bytes or single-segment read-only buffer";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001450 return -1;
1451 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001452 count = view.len;
1453 *p = view.buf;
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001454 PyBuffer_Release(&view);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001455 return count;
1456}
Guido van Rossumaa354651996-08-19 19:32:04 +00001457
Martin v. Löwis423be952008-08-13 15:53:07 +00001458/* XXX for 3.x, getbuffer and convertbuffer can probably
1459 be merged again. */
1460static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001461getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001462{
1463 void *buf;
1464 Py_ssize_t count;
1465 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1466 if (pb == NULL) {
Benjamin Peterson81d90a22008-12-27 02:58:34 +00001467 *errmsg = "bytes or buffer";
Martin v. Löwis423be952008-08-13 15:53:07 +00001468 return -1;
1469 }
1470 if (pb->bf_getbuffer) {
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001471 if (PyObject_GetBuffer(arg, view, 0) < 0) {
Neal Norwitz2f99b242008-08-24 05:48:10 +00001472 *errmsg = "convertible to a buffer";
Martin v. Löwis423be952008-08-13 15:53:07 +00001473 return -1;
Neal Norwitz2f99b242008-08-24 05:48:10 +00001474 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001475 if (!PyBuffer_IsContiguous(view, 'C')) {
1476 *errmsg = "contiguous buffer";
1477 return -1;
1478 }
1479 return 0;
1480 }
1481
1482 count = convertbuffer(arg, &buf, errmsg);
Neal Norwitz2f99b242008-08-24 05:48:10 +00001483 if (count < 0) {
1484 *errmsg = "convertible to a buffer";
Martin v. Löwis423be952008-08-13 15:53:07 +00001485 return count;
Neal Norwitz2f99b242008-08-24 05:48:10 +00001486 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001487 PyBuffer_FillInfo(view, NULL, buf, count, 1, 0);
1488 return 0;
1489}
1490
Guido van Rossumaa354651996-08-19 19:32:04 +00001491/* Support for keyword arguments donated by
1492 Geoff Philbrick <philbric@delphi.hks.com> */
1493
Tim Petersf8cd3e82001-10-27 04:26:57 +00001494/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001495int
1496PyArg_ParseTupleAndKeywords(PyObject *args,
1497 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001498 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001499 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001500{
1501 int retval;
1502 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001503
1504 if ((args == NULL || !PyTuple_Check(args)) ||
1505 (keywords != NULL && !PyDict_Check(keywords)) ||
1506 format == NULL ||
1507 kwlist == NULL)
1508 {
1509 PyErr_BadInternalCall();
Tim Petersf8cd3e82001-10-27 04:26:57 +00001510 return 0;
Tim Peters45772cd2001-10-27 03:58:40 +00001511 }
1512
Guido van Rossumaa354651996-08-19 19:32:04 +00001513 va_start(va, kwlist);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001514 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001515 va_end(va);
1516 return retval;
1517}
1518
1519int
1520_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1521 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001522 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001523 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001524{
1525 int retval;
1526 va_list va;
1527
1528 if ((args == NULL || !PyTuple_Check(args)) ||
1529 (keywords != NULL && !PyDict_Check(keywords)) ||
1530 format == NULL ||
1531 kwlist == NULL)
1532 {
1533 PyErr_BadInternalCall();
1534 return 0;
1535 }
1536
1537 va_start(va, kwlist);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001538 retval = vgetargskeywords(args, keywords, format,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001539 kwlist, &va, FLAG_SIZE_T);
Guido van Rossumaa354651996-08-19 19:32:04 +00001540 va_end(va);
1541 return retval;
1542}
1543
1544
Brett Cannon711e7d92004-07-10 22:20:32 +00001545int
1546PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001547 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001548 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001549 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001550{
1551 int retval;
1552 va_list lva;
1553
1554 if ((args == NULL || !PyTuple_Check(args)) ||
1555 (keywords != NULL && !PyDict_Check(keywords)) ||
1556 format == NULL ||
1557 kwlist == NULL)
1558 {
1559 PyErr_BadInternalCall();
1560 return 0;
1561 }
1562
1563#ifdef VA_LIST_IS_ARRAY
1564 memcpy(lva, va, sizeof(va_list));
1565#else
1566#ifdef __va_copy
1567 __va_copy(lva, va);
1568#else
1569 lva = va;
1570#endif
1571#endif
1572
Guido van Rossum98297ee2007-11-06 21:34:58 +00001573 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001574 return retval;
1575}
1576
1577int
1578_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1579 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001580 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001581 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001582{
1583 int retval;
1584 va_list lva;
1585
1586 if ((args == NULL || !PyTuple_Check(args)) ||
1587 (keywords != NULL && !PyDict_Check(keywords)) ||
1588 format == NULL ||
1589 kwlist == NULL)
1590 {
1591 PyErr_BadInternalCall();
1592 return 0;
1593 }
1594
1595#ifdef VA_LIST_IS_ARRAY
1596 memcpy(lva, va, sizeof(va_list));
1597#else
1598#ifdef __va_copy
1599 __va_copy(lva, va);
1600#else
1601 lva = va;
1602#endif
1603#endif
1604
Guido van Rossum98297ee2007-11-06 21:34:58 +00001605 retval = vgetargskeywords(args, keywords, format,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001606 kwlist, &lva, FLAG_SIZE_T);
Brett Cannon711e7d92004-07-10 22:20:32 +00001607 return retval;
1608}
1609
Christian Heimes380f7f22008-02-28 11:19:05 +00001610#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001611
Guido van Rossumaa354651996-08-19 19:32:04 +00001612static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001613vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001614 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001615{
Tim Petersdc5eff92001-10-27 06:53:00 +00001616 char msgbuf[512];
Guido van Rossumaa354651996-08-19 19:32:04 +00001617 int levels[32];
Christian Heimes380f7f22008-02-28 11:19:05 +00001618 const char *fname, *msg, *custom_msg, *keyword;
1619 int min = INT_MAX;
Tim Petersb639d492001-10-27 07:00:56 +00001620 int i, len, nargs, nkeywords;
Christian Heimes380f7f22008-02-28 11:19:05 +00001621 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001622
Tim Peters45772cd2001-10-27 03:58:40 +00001623 assert(args != NULL && PyTuple_Check(args));
1624 assert(keywords == NULL || PyDict_Check(keywords));
1625 assert(format != NULL);
1626 assert(kwlist != NULL);
1627 assert(p_va != NULL);
1628
Christian Heimes380f7f22008-02-28 11:19:05 +00001629 /* grab the function name or custom error msg first (mutually exclusive) */
1630 fname = strchr(format, ':');
1631 if (fname) {
1632 fname++;
1633 custom_msg = NULL;
Tim Peters62d48e12001-10-27 06:42:16 +00001634 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001635 else {
1636 custom_msg = strchr(format,';');
1637 if (custom_msg)
1638 custom_msg++;
Tim Peters62d48e12001-10-27 06:42:16 +00001639 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001640
1641 /* scan kwlist and get greatest possible nbr of args */
1642 for (len=0; kwlist[len]; len++)
1643 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001644
Tim Peters6fb26352001-10-27 04:38:11 +00001645 nargs = PyTuple_GET_SIZE(args);
Christian Heimes380f7f22008-02-28 11:19:05 +00001646 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1647 if (nargs + nkeywords > len) {
1648 PyErr_Format(PyExc_TypeError, "%s%s takes at most %d "
1649 "argument%s (%d given)",
1650 (fname == NULL) ? "function" : fname,
1651 (fname == NULL) ? "" : "()",
1652 len,
1653 (len == 1) ? "" : "s",
1654 nargs + nkeywords);
Guido van Rossumaa354651996-08-19 19:32:04 +00001655 return 0;
1656 }
Tim Petersc2f01122001-10-27 07:25:06 +00001657
Christian Heimes380f7f22008-02-28 11:19:05 +00001658 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1659 for (i = 0; i < len; i++) {
1660 keyword = kwlist[i];
1661 if (*format == '|') {
1662 min = i;
Guido van Rossumaa354651996-08-19 19:32:04 +00001663 format++;
Christian Heimes380f7f22008-02-28 11:19:05 +00001664 }
1665 if (IS_END_OF_FORMAT(*format)) {
1666 PyErr_Format(PyExc_RuntimeError,
1667 "More keyword list entries (%d) than "
1668 "format specifiers (%d)", len, i);
1669 return cleanreturn(0, freelist);
1670 }
1671 current_arg = NULL;
1672 if (nkeywords) {
1673 current_arg = PyDict_GetItemString(keywords, keyword);
1674 }
1675 if (current_arg) {
1676 --nkeywords;
1677 if (i < nargs) {
1678 /* arg present in tuple and in dict */
1679 PyErr_Format(PyExc_TypeError,
1680 "Argument given by name ('%s') "
1681 "and position (%d)",
1682 keyword, i+1);
1683 return cleanreturn(0, freelist);
1684 }
1685 }
1686 else if (nkeywords && PyErr_Occurred())
1687 return cleanreturn(0, freelist);
1688 else if (i < nargs)
1689 current_arg = PyTuple_GET_ITEM(args, i);
1690
1691 if (current_arg) {
1692 msg = convertitem(current_arg, &format, p_va, flags,
1693 levels, msgbuf, sizeof(msgbuf), &freelist);
1694 if (msg) {
1695 seterror(i+1, msg, levels, fname, custom_msg);
1696 return cleanreturn(0, freelist);
1697 }
1698 continue;
1699 }
1700
1701 if (i < min) {
1702 PyErr_Format(PyExc_TypeError, "Required argument "
1703 "'%s' (pos %d) not found",
1704 keyword, i+1);
1705 return cleanreturn(0, freelist);
1706 }
1707 /* current code reports success when all required args
1708 * fulfilled and no keyword args left, with no further
1709 * validation. XXX Maybe skip this in debug build ?
1710 */
1711 if (!nkeywords)
1712 return cleanreturn(1, freelist);
1713
1714 /* We are into optional args, skip thru to any remaining
1715 * keyword args */
1716 msg = skipitem(&format, p_va, flags);
Guido van Rossumaa354651996-08-19 19:32:04 +00001717 if (msg) {
Christian Heimes380f7f22008-02-28 11:19:05 +00001718 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1719 format);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001720 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001721 }
1722 }
1723
Benjamin Peterson92035012008-12-27 16:00:54 +00001724 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
Christian Heimes380f7f22008-02-28 11:19:05 +00001725 PyErr_Format(PyExc_RuntimeError,
1726 "more argument specifiers than keyword list entries "
1727 "(remaining format:'%s')", format);
1728 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001729 }
Tim Petersb054be42001-10-27 05:07:41 +00001730
Guido van Rossumaa354651996-08-19 19:32:04 +00001731 /* make sure there are no extraneous keyword arguments */
Tim Petersc2f01122001-10-27 07:25:06 +00001732 if (nkeywords > 0) {
1733 PyObject *key, *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001734 Py_ssize_t pos = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001735 while (PyDict_Next(keywords, &pos, &key, &value)) {
Tim Petersc2f01122001-10-27 07:25:06 +00001736 int match = 0;
Guido van Rossum55474762002-04-04 16:22:30 +00001737 char *ks;
Georg Brandld8b690f2008-05-16 17:28:50 +00001738 if (!PyUnicode_Check(key)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00001739 PyErr_SetString(PyExc_TypeError,
Guido van Rossum55474762002-04-04 16:22:30 +00001740 "keywords must be strings");
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001741 return cleanreturn(0, freelist);
Guido van Rossum55474762002-04-04 16:22:30 +00001742 }
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001743 ks = _PyUnicode_AsString(key);
Christian Heimes380f7f22008-02-28 11:19:05 +00001744 for (i = 0; i < len; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001745 if (!strcmp(ks, kwlist[i])) {
1746 match = 1;
1747 break;
1748 }
1749 }
1750 if (!match) {
Tim Petersc2f01122001-10-27 07:25:06 +00001751 PyErr_Format(PyExc_TypeError,
1752 "'%s' is an invalid keyword "
1753 "argument for this function",
1754 ks);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001755 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001756 }
1757 }
1758 }
Tim Petersc2f01122001-10-27 07:25:06 +00001759
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001760 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001761}
1762
1763
1764static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001765skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001766{
Christian Heimes380f7f22008-02-28 11:19:05 +00001767 const char *format = *p_format;
Guido van Rossumaa354651996-08-19 19:32:04 +00001768 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001769
Guido van Rossumaa354651996-08-19 19:32:04 +00001770 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001771
1772 /* simple codes
1773 * The individual types (second arg of va_arg) are irrelevant */
1774
Guido van Rossumaa354651996-08-19 19:32:04 +00001775 case 'b': /* byte -- very short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001776 case 'B': /* byte as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001777 case 'h': /* short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001778 case 'H': /* short int as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001779 case 'i': /* int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001780 case 'I': /* int sized bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001781 case 'l': /* long int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001782 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001783#ifdef HAVE_LONG_LONG
Georg Brandl6dd14612005-09-14 19:29:53 +00001784 case 'L': /* PY_LONG_LONG */
1785 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001786#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001787 case 'f': /* float */
Guido van Rossumaa354651996-08-19 19:32:04 +00001788 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001789 case 'D': /* complex double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001790 case 'c': /* char */
Mark Dickinsonf08173b2009-12-03 10:59:46 +00001791 case 'C': /* unicode char */
Guido van Rossumaa354651996-08-19 19:32:04 +00001792 {
Georg Brandl6dd14612005-09-14 19:29:53 +00001793 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001794 break;
1795 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001796
1797 case 'n': /* Py_ssize_t */
1798 {
1799 (void) va_arg(*p_va, Py_ssize_t *);
1800 break;
1801 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001802
Georg Brandl6dd14612005-09-14 19:29:53 +00001803 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001804
Georg Brandl6dd14612005-09-14 19:29:53 +00001805 case 'e': /* string with encoding */
1806 {
1807 (void) va_arg(*p_va, const char *);
1808 if (!(*format == 's' || *format == 't'))
1809 /* after 'e', only 's' and 't' is allowed */
1810 goto err;
1811 format++;
1812 /* explicit fallthrough to string cases */
1813 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001814
Guido van Rossumaa354651996-08-19 19:32:04 +00001815 case 's': /* string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001816 case 'z': /* string or None */
Walter Dörwald612344f2007-05-04 19:28:21 +00001817 case 'y': /* bytes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001818 case 'u': /* unicode string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001819 case 't': /* buffer, read-only */
1820 case 'w': /* buffer, read-write */
Guido van Rossumaa354651996-08-19 19:32:04 +00001821 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001822 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001823 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001824 if (flags & FLAG_SIZE_T)
1825 (void) va_arg(*p_va, Py_ssize_t *);
1826 else
1827 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001828 format++;
Martin v. Löwis423be952008-08-13 15:53:07 +00001829 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1830 format++;
Guido van Rossumaa354651996-08-19 19:32:04 +00001831 }
1832 break;
1833 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001834
1835 /* object codes */
1836
Guido van Rossumaa354651996-08-19 19:32:04 +00001837 case 'S': /* string object */
Guido van Rossum617dbc42007-05-07 23:57:08 +00001838 case 'Y': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001839 case 'U': /* unicode string object */
Guido van Rossumaa354651996-08-19 19:32:04 +00001840 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001841 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001842 break;
1843 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001844
Guido van Rossumaa354651996-08-19 19:32:04 +00001845 case 'O': /* object */
1846 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001847 if (*format == '!') {
1848 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001849 (void) va_arg(*p_va, PyTypeObject*);
1850 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001851 }
1852#if 0
1853/* I don't know what this is for */
1854 else if (*format == '?') {
1855 inquiry pred = va_arg(*p_va, inquiry);
1856 format++;
1857 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001858 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001859 }
1860 }
1861#endif
1862 else if (*format == '&') {
Tim Petersdbd9ba62000-07-09 03:09:57 +00001863 typedef int (*converter)(PyObject *, void *);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001864 (void) va_arg(*p_va, converter);
1865 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001866 format++;
1867 }
1868 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001869 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001870 }
1871 break;
1872 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001873
Christian Heimes380f7f22008-02-28 11:19:05 +00001874 case '(': /* bypass tuple, not handled at all previously */
1875 {
1876 char *msg;
1877 for (;;) {
1878 if (*format==')')
1879 break;
1880 if (IS_END_OF_FORMAT(*format))
1881 return "Unmatched left paren in format "
1882 "string";
1883 msg = skipitem(&format, p_va, flags);
1884 if (msg)
1885 return msg;
1886 }
1887 format++;
1888 break;
1889 }
1890
1891 case ')':
1892 return "Unmatched right paren in format string";
1893
Guido van Rossumaa354651996-08-19 19:32:04 +00001894 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001895err:
Guido van Rossumaa354651996-08-19 19:32:04 +00001896 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001897
Guido van Rossumaa354651996-08-19 19:32:04 +00001898 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001899
Guido van Rossumaa354651996-08-19 19:32:04 +00001900 *p_format = format;
1901 return NULL;
1902}
Fred Drakee4616e62001-10-23 21:09:29 +00001903
1904
1905int
Martin v. Löwis76246742006-03-01 04:06:10 +00001906PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001907{
Martin v. Löwis76246742006-03-01 04:06:10 +00001908 Py_ssize_t i, l;
Fred Drakee4616e62001-10-23 21:09:29 +00001909 PyObject **o;
1910 va_list vargs;
1911
1912#ifdef HAVE_STDARG_PROTOTYPES
1913 va_start(vargs, max);
1914#else
1915 va_start(vargs);
1916#endif
1917
1918 assert(min >= 0);
1919 assert(min <= max);
1920 if (!PyTuple_Check(args)) {
1921 PyErr_SetString(PyExc_SystemError,
1922 "PyArg_UnpackTuple() argument list is not a tuple");
1923 return 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001924 }
Fred Drakee4616e62001-10-23 21:09:29 +00001925 l = PyTuple_GET_SIZE(args);
1926 if (l < min) {
1927 if (name != NULL)
1928 PyErr_Format(
1929 PyExc_TypeError,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001930 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001931 name, (min == max ? "" : "at least "), min, l);
1932 else
1933 PyErr_Format(
1934 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001935 "unpacked tuple should have %s%zd elements,"
Guido van Rossum98297ee2007-11-06 21:34:58 +00001936 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001937 (min == max ? "" : "at least "), min, l);
1938 va_end(vargs);
1939 return 0;
1940 }
1941 if (l > max) {
1942 if (name != NULL)
1943 PyErr_Format(
1944 PyExc_TypeError,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001945 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001946 name, (min == max ? "" : "at most "), max, l);
1947 else
1948 PyErr_Format(
1949 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001950 "unpacked tuple should have %s%zd elements,"
Guido van Rossum98297ee2007-11-06 21:34:58 +00001951 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001952 (min == max ? "" : "at most "), max, l);
1953 va_end(vargs);
1954 return 0;
1955 }
1956 for (i = 0; i < l; i++) {
1957 o = va_arg(vargs, PyObject **);
1958 *o = PyTuple_GET_ITEM(args, i);
1959 }
1960 va_end(vargs);
1961 return 1;
1962}
Georg Brandl02c42872005-08-26 06:42:30 +00001963
1964
1965/* For type constructors that don't take keyword args
1966 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001967 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001968 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001969 */
1970int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001971_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001972{
1973 if (kw == NULL)
1974 return 1;
1975 if (!PyDict_CheckExact(kw)) {
1976 PyErr_BadInternalCall();
1977 return 0;
1978 }
1979 if (PyDict_Size(kw) == 0)
1980 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001981
1982 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
Georg Brandl02c42872005-08-26 06:42:30 +00001983 funcname);
1984 return 0;
1985}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001986#ifdef __cplusplus
1987};
1988#endif