blob: b69aaed56cf01158885a8032502c5f88d0947012 [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
Guido van Rossum45aecf42006-03-15 04:58:47 +0000585/* Explicitly check for float arguments when integers are expected.
586 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000587static int
588float_argument_error(PyObject *arg)
589{
Guido van Rossum45aecf42006-03-15 04:58:47 +0000590 if (PyFloat_Check(arg)) {
591 PyErr_SetString(PyExc_TypeError,
592 "integer argument expected, got float" );
Neil Schemenauer5042da62003-02-04 20:59:40 +0000593 return 1;
Guido van Rossum45aecf42006-03-15 04:58:47 +0000594 }
Neil Schemenauer5042da62003-02-04 20:59:40 +0000595 else
596 return 0;
597}
598
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000599/* Convert a non-tuple argument. Return NULL if conversion went OK,
600 or a string with a message describing the failure. The message is
601 formatted as "must be <desired type>, not <actual type>".
602 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000603 Don't call if a tuple is expected.
604
605 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000606*/
607
608static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000609convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000610 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000611{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000612 /* For # codes */
613#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
614 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
615 else q=va_arg(*p_va, int*);
616#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
617#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
618
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000619 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000620 char c = *format++;
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000621 PyObject *uarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000622
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000623 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000624
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000625 case 'b': { /* unsigned byte -- very short int */
626 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000627 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000628 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000629 return converterr("integer<b>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000630 ival = PyLong_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000631 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000632 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000633 else if (ival < 0) {
634 PyErr_SetString(PyExc_OverflowError,
635 "unsigned byte integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000636 return converterr("integer<b>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000637 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000638 else if (ival > UCHAR_MAX) {
639 PyErr_SetString(PyExc_OverflowError,
640 "unsigned byte integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000641 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000642 }
643 else
644 *p = (unsigned char) ival;
645 break;
646 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000647
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000648 case 'B': {/* byte sized bitfield - both signed and unsigned
Guido van Rossum98297ee2007-11-06 21:34:58 +0000649 values allowed */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000650 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000651 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000652 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000653 return converterr("integer<B>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000654 ival = PyLong_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000655 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000656 return converterr("integer<B>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000657 else
658 *p = (unsigned char) ival;
659 break;
660 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000661
Guido van Rossumfce26e72003-04-18 00:12:30 +0000662 case 'h': {/* signed short int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000663 short *p = va_arg(*p_va, short *);
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<h>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000667 ival = PyLong_AsLong(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<h>", arg, msgbuf, bufsize);
Guido van Rossumfce26e72003-04-18 00:12:30 +0000670 else if (ival < SHRT_MIN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000671 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000672 "signed short integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000673 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000674 }
Guido van Rossumfce26e72003-04-18 00:12:30 +0000675 else if (ival > SHRT_MAX) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000676 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000677 "signed short integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000678 return converterr("integer<h>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000679 }
680 else
681 *p = (short) ival;
682 break;
683 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000684
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000685 case 'H': { /* short int sized bitfield, both signed and
Guido van Rossum98297ee2007-11-06 21:34:58 +0000686 unsigned allowed */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000687 unsigned short *p = va_arg(*p_va, unsigned short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000688 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000689 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000690 return converterr("integer<H>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000691 ival = PyLong_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000692 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000693 return converterr("integer<H>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000694 else
695 *p = (unsigned short) ival;
696 break;
697 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000698
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000699 case 'i': {/* signed int */
700 int *p = va_arg(*p_va, int *);
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<i>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000704 ival = PyLong_AsLong(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<i>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000707 else if (ival > INT_MAX) {
708 PyErr_SetString(PyExc_OverflowError,
709 "signed integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000710 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000711 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000712 else if (ival < INT_MIN) {
713 PyErr_SetString(PyExc_OverflowError,
714 "signed integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000715 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000716 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000717 else
718 *p = ival;
719 break;
720 }
721
Thomas Hellera4ea6032003-04-17 18:55:45 +0000722 case 'I': { /* int sized bitfield, both signed and
Guido van Rossum98297ee2007-11-06 21:34:58 +0000723 unsigned allowed */
Thomas Hellera4ea6032003-04-17 18:55:45 +0000724 unsigned int *p = va_arg(*p_va, unsigned int *);
725 unsigned int ival;
726 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000727 return converterr("integer<I>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000728 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000729 if (ival == (unsigned int)-1 && PyErr_Occurred())
Thomas Hellera4ea6032003-04-17 18:55:45 +0000730 return converterr("integer<I>", arg, msgbuf, bufsize);
731 else
732 *p = ival;
733 break;
734 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000735
Martin v. Löwis18e16552006-02-15 17:27:45 +0000736 case 'n': /* Py_ssize_t */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000737 {
Neal Norwitzb879f572007-08-31 05:20:36 +0000738 PyObject *iobj;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000739 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
Neal Norwitzb879f572007-08-31 05:20:36 +0000740 Py_ssize_t ival = -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000741 if (float_argument_error(arg))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000742 return converterr("integer<n>", arg, msgbuf, bufsize);
Neal Norwitzb879f572007-08-31 05:20:36 +0000743 iobj = PyNumber_Index(arg);
Christian Heimesbcd2c082008-05-08 01:20:25 +0000744 if (iobj != NULL) {
Trent Nelson35133582008-04-22 19:02:40 +0000745 ival = PyLong_AsSsize_t(iobj);
Christian Heimesbcd2c082008-05-08 01:20:25 +0000746 Py_DECREF(iobj);
747 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000748 if (ival == -1 && PyErr_Occurred())
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000749 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000750 *p = ival;
751 break;
752 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000753 case 'l': {/* long int */
754 long *p = va_arg(*p_va, long *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000755 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000756 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000757 return converterr("integer<l>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000758 ival = PyLong_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000759 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000760 return converterr("integer<l>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000761 else
762 *p = ival;
763 break;
764 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000765
766 case 'k': { /* long sized bitfield */
767 unsigned long *p = va_arg(*p_va, unsigned long *);
768 unsigned long ival;
Georg Brandle1a0d112007-10-23 19:24:22 +0000769 if (PyLong_Check(arg))
Thomas Hellera4ea6032003-04-17 18:55:45 +0000770 ival = PyLong_AsUnsignedLongMask(arg);
771 else
772 return converterr("integer<k>", arg, msgbuf, bufsize);
773 *p = ival;
774 break;
775 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000776
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000777#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000778 case 'L': {/* PY_LONG_LONG */
779 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
780 PY_LONG_LONG ival = PyLong_AsLongLong( arg );
Christian Heimes836baa52008-02-26 08:18:30 +0000781 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000782 return converterr("long<L>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000783 } else {
784 *p = ival;
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000785 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000786 break;
787 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000788
789 case 'K': { /* long long sized bitfield */
790 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
791 unsigned PY_LONG_LONG ival;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000792 if (PyLong_Check(arg))
Thomas Hellera4ea6032003-04-17 18:55:45 +0000793 ival = PyLong_AsUnsignedLongLongMask(arg);
794 else
795 return converterr("integer<K>", arg, msgbuf, bufsize);
796 *p = ival;
797 break;
798 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000799#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000800
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000801 case 'f': {/* float */
802 float *p = va_arg(*p_va, float *);
803 double dval = PyFloat_AsDouble(arg);
804 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000805 return converterr("float<f>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000806 else
807 *p = (float) dval;
808 break;
809 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000810
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000811 case 'd': {/* double */
812 double *p = va_arg(*p_va, double *);
813 double dval = PyFloat_AsDouble(arg);
814 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000815 return converterr("float<d>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000816 else
817 *p = dval;
818 break;
819 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000820
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000821 case 'D': {/* complex double */
822 Py_complex *p = va_arg(*p_va, Py_complex *);
823 Py_complex cval;
824 cval = PyComplex_AsCComplex(arg);
825 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000826 return converterr("complex<D>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000827 else
828 *p = cval;
829 break;
830 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000831
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000832 case 'c': {/* char */
Walter Dörwaldd0941302007-07-01 21:58:22 +0000833 char *p = va_arg(*p_va, char *);
Christian Heimes72b710a2008-05-26 13:28:38 +0000834 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
835 *p = PyBytes_AS_STRING(arg)[0];
Walter Dörwaldd0941302007-07-01 21:58:22 +0000836 else
Benjamin Peterson7fe98532009-04-02 00:33:55 +0000837 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
Walter Dörwaldd0941302007-07-01 21:58:22 +0000838 break;
839 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000840
Walter Dörwaldd0941302007-07-01 21:58:22 +0000841 case 'C': {/* unicode char */
Walter Dörwaldbc1f8862007-06-20 11:02:38 +0000842 int *p = va_arg(*p_va, int *);
Benjamin Peterson7fe98532009-04-02 00:33:55 +0000843 if (PyUnicode_Check(arg) &&
844 PyUnicode_GET_SIZE(arg) == 1)
Guido van Rossum09dc34f2007-05-04 04:17:33 +0000845 *p = PyUnicode_AS_UNICODE(arg)[0];
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000846 else
Benjamin Peterson7fe98532009-04-02 00:33:55 +0000847 return converterr("a unicode character", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000848 break;
849 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000850
851 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w', 't' codes all
852 need to be cleaned up! */
853
854 case 's': {/* text string */
Martin v. Löwis423be952008-08-13 15:53:07 +0000855 if (*format == '*') {
856 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
857
858 if (PyUnicode_Check(arg)) {
859 uarg = UNICODE_DEFAULT_ENCODING(arg);
860 if (uarg == NULL)
861 return converterr(CONV_UNICODE,
862 arg, msgbuf, bufsize);
863 PyBuffer_FillInfo(p, arg,
864 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
865 1, 0);
866 }
867 else { /* any buffer-like object */
868 char *buf;
869 if (getbuffer(arg, p, &buf) < 0)
870 return converterr(buf, arg, msgbuf, bufsize);
871 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000872 if (addcleanup(p, freelist, cleanup_buffer)) {
873 return converterr(
874 "(cleanup problem)",
875 arg, msgbuf, bufsize);
876 }
Martin v. Löwis423be952008-08-13 15:53:07 +0000877 format++;
878 } else if (*format == '#') {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000879 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000880 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000881
882 if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000883 uarg = UNICODE_DEFAULT_ENCODING(arg);
884 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000885 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000886 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000887 *p = PyBytes_AS_STRING(uarg);
888 STORE_SIZE(PyBytes_GET_SIZE(uarg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000889 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000890 else { /* any buffer-like object */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000891 /* XXX Really? */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000892 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000893 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000894 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000895 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000896 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000897 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000898 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000899 } else {
900 char **p = va_arg(*p_va, char **);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000901
902 if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000903 uarg = UNICODE_DEFAULT_ENCODING(arg);
904 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000905 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000906 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000907 *p = PyBytes_AS_STRING(uarg);
Marc-André Lemburg6f15e572001-05-02 17:16:16 +0000908 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000909 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000910 return converterr("string", arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000911 if ((Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000912 return converterr("string without null bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000913 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000914 }
915 break;
916 }
917
Guido van Rossum98297ee2007-11-06 21:34:58 +0000918 case 'y': {/* any buffer-like object, but not PyUnicode */
919 void **p = (void **)va_arg(*p_va, char **);
920 char *buf;
Martin v. Löwis423be952008-08-13 15:53:07 +0000921 Py_ssize_t count;
922 if (*format == '*') {
923 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
924 return converterr(buf, arg, msgbuf, bufsize);
925 format++;
Antoine Pitrouf71995782008-08-29 18:37:05 +0000926 if (addcleanup(p, freelist, cleanup_buffer)) {
927 return converterr(
928 "(cleanup problem)",
929 arg, msgbuf, bufsize);
930 }
Martin v. Löwis423be952008-08-13 15:53:07 +0000931 break;
932 }
933 count = convertbuffer(arg, p, &buf);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000934 if (count < 0)
935 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis423be952008-08-13 15:53:07 +0000936 else if (*format == '#') {
Walter Dörwald612344f2007-05-04 19:28:21 +0000937 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000938 STORE_SIZE(count);
Walter Dörwald612344f2007-05-04 19:28:21 +0000939 format++;
Walter Dörwald612344f2007-05-04 19:28:21 +0000940 }
941 break;
942 }
943
Guido van Rossum98297ee2007-11-06 21:34:58 +0000944 case 'z': {/* like 's' or 's#', but None is okay, stored as NULL */
Martin v. Löwis423be952008-08-13 15:53:07 +0000945 if (*format == '*') {
946 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
947
948 if (arg == Py_None)
949 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
950 else if (PyUnicode_Check(arg)) {
951 uarg = UNICODE_DEFAULT_ENCODING(arg);
952 if (uarg == NULL)
953 return converterr(CONV_UNICODE,
954 arg, msgbuf, bufsize);
955 PyBuffer_FillInfo(p, arg,
956 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
957 1, 0);
958 }
959 else { /* any buffer-like object */
960 char *buf;
961 if (getbuffer(arg, p, &buf) < 0)
962 return converterr(buf, arg, msgbuf, bufsize);
963 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000964 if (addcleanup(p, freelist, cleanup_buffer)) {
965 return converterr(
966 "(cleanup problem)",
967 arg, msgbuf, bufsize);
968 }
Martin v. Löwis423be952008-08-13 15:53:07 +0000969 format++;
970 } else if (*format == '#') { /* any buffer-like object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000971 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000972 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000973
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000974 if (arg == Py_None) {
975 *p = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000976 STORE_SIZE(0);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000977 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000978 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000979 uarg = UNICODE_DEFAULT_ENCODING(arg);
980 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000981 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000982 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000983 *p = PyBytes_AS_STRING(uarg);
984 STORE_SIZE(PyBytes_GET_SIZE(uarg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000985 }
986 else { /* any buffer-like object */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000987 /* XXX Really? */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000988 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000989 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000990 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000991 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000992 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000993 }
994 format++;
995 } else {
996 char **p = va_arg(*p_va, char **);
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +0000997 uarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000998
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000999 if (arg == Py_None)
1000 *p = 0;
Christian Heimes72b710a2008-05-26 13:28:38 +00001001 else if (PyBytes_Check(arg)) {
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +00001002 /* Enable null byte check below */
1003 uarg = arg;
Christian Heimes72b710a2008-05-26 13:28:38 +00001004 *p = PyBytes_AS_STRING(arg);
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +00001005 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001006 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +00001007 uarg = UNICODE_DEFAULT_ENCODING(arg);
1008 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001009 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001010 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +00001011 *p = PyBytes_AS_STRING(uarg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001012 }
1013 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001014 return converterr("string or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001015 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001016 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001017 FETCH_SIZE;
Thomas Woutersc3547a32006-03-01 21:31:21 +00001018 assert(0); /* XXX redundant with if-case */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001019 if (arg == Py_None) {
1020 STORE_SIZE(0);
1021 }
1022 else {
Christian Heimes72b710a2008-05-26 13:28:38 +00001023 STORE_SIZE(PyBytes_Size(arg));
Guido van Rossum98297ee2007-11-06 21:34:58 +00001024 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001025 format++;
1026 }
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +00001027 else if (*p != NULL && uarg != NULL &&
Christian Heimes72b710a2008-05-26 13:28:38 +00001028 (Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001029 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001030 "string without null bytes or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001031 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001032 }
1033 break;
1034 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001035
Guido van Rossumfb67be22007-08-29 18:38:11 +00001036 case 'Z': {/* unicode, may be NULL (None) */
1037 if (*format == '#') { /* any buffer-like object */
1038 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1039 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001040
Guido van Rossumfb67be22007-08-29 18:38:11 +00001041 if (arg == Py_None) {
1042 *p = 0;
1043 STORE_SIZE(0);
1044 }
1045 else if (PyUnicode_Check(arg)) {
1046 *p = PyUnicode_AS_UNICODE(arg);
1047 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1048 }
1049 format++;
1050 } else {
1051 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001052
Guido van Rossumfb67be22007-08-29 18:38:11 +00001053 if (arg == Py_None)
1054 *p = 0;
1055 else if (PyUnicode_Check(arg))
1056 *p = PyUnicode_AS_UNICODE(arg);
1057 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001058 return converterr("string or None",
Guido van Rossumfb67be22007-08-29 18:38:11 +00001059 arg, msgbuf, bufsize);
1060 }
1061 break;
1062 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001063
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001064 case 'e': {/* encoded string */
1065 char **buffer;
1066 const char *encoding;
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001067 PyObject *s;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001068 int recode_strings;
1069 Py_ssize_t size;
Guido van Rossumd70539a2007-05-09 23:35:09 +00001070 const char *ptr;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001071
1072 /* Get 'e' parameter: the encoding name */
1073 encoding = (const char *)va_arg(*p_va, const char *);
1074 if (encoding == NULL)
1075 encoding = PyUnicode_GetDefaultEncoding();
Guido van Rossum98297ee2007-11-06 21:34:58 +00001076
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001077 /* Get output buffer parameter:
1078 's' (recode all objects via Unicode) or
Guido van Rossum98297ee2007-11-06 21:34:58 +00001079 't' (only recode non-string objects)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001080 */
1081 if (*format == 's')
1082 recode_strings = 1;
1083 else if (*format == 't')
1084 recode_strings = 0;
1085 else
1086 return converterr(
1087 "(unknown parser marker combination)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001088 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001089 buffer = (char **)va_arg(*p_va, char **);
1090 format++;
1091 if (buffer == NULL)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001092 return converterr("(buffer is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001093 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001094
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001095 /* Encode object */
Guido van Rossumd70539a2007-05-09 23:35:09 +00001096 if (!recode_strings &&
Christian Heimes72b710a2008-05-26 13:28:38 +00001097 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001098 s = arg;
1099 Py_INCREF(s);
Guido van Rossumd70539a2007-05-09 23:35:09 +00001100 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1101 return converterr("(AsCharBuffer failed)",
1102 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001103 }
1104 else {
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001105 PyObject *u;
1106
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001107 /* Convert object to Unicode */
1108 u = PyUnicode_FromObject(arg);
1109 if (u == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001110 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001111 "string or unicode or text buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001112 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001113
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001114 /* Encode object; use default error handling */
1115 s = PyUnicode_AsEncodedString(u,
1116 encoding,
1117 NULL);
1118 Py_DECREF(u);
1119 if (s == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001120 return converterr("(encoding failed)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001121 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +00001122 if (!PyBytes_Check(s)) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001123 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001124 return converterr(
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001125 "(encoder failed to return bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001126 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001127 }
Christian Heimes72b710a2008-05-26 13:28:38 +00001128 size = PyBytes_GET_SIZE(s);
1129 ptr = PyBytes_AS_STRING(s);
Guido van Rossumd70539a2007-05-09 23:35:09 +00001130 if (ptr == NULL)
1131 ptr = "";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001132 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001133
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001134 /* Write output; output is guaranteed to be 0-terminated */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001135 if (*format == '#') {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001136 /* Using buffer length parameter '#':
Guido van Rossum98297ee2007-11-06 21:34:58 +00001137
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001138 - if *buffer is NULL, a new buffer of the
1139 needed size is allocated and the data
1140 copied into it; *buffer is updated to point
1141 to the new buffer; the caller is
1142 responsible for PyMem_Free()ing it after
Guido van Rossum98297ee2007-11-06 21:34:58 +00001143 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001144
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001145 - if *buffer is not NULL, the data is
1146 copied to *buffer; *buffer_len has to be
1147 set to the size of the buffer on input;
1148 buffer overflow is signalled with an error;
1149 buffer has to provide enough room for the
1150 encoded string plus the trailing 0-byte
Guido van Rossum98297ee2007-11-06 21:34:58 +00001151
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001152 - in both cases, *buffer_len is updated to
1153 the size of the buffer /excluding/ the
Guido van Rossum98297ee2007-11-06 21:34:58 +00001154 trailing 0-byte
1155
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001156 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001157 FETCH_SIZE;
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001158
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001159 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001160 if (q == NULL && q2 == NULL) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001161 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001162 return converterr(
1163 "(buffer_len is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001164 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001165 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001166 if (*buffer == NULL) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001167 *buffer = PyMem_NEW(char, size + 1);
1168 if (*buffer == NULL) {
1169 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001170 return converterr(
1171 "(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001172 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001173 }
Antoine Pitrouf71995782008-08-29 18:37:05 +00001174 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001175 Py_DECREF(s);
1176 return converterr(
1177 "(cleanup problem)",
1178 arg, msgbuf, bufsize);
1179 }
Fred Drake25871c02000-05-03 15:17:02 +00001180 } else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001181 if (size + 1 > BUFFER_LEN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001182 Py_DECREF(s);
1183 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001184 "(buffer overflow)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001185 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001186 }
Fred Drake25871c02000-05-03 15:17:02 +00001187 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001188 memcpy(*buffer, ptr, size+1);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001189 STORE_SIZE(size);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001190 } else {
1191 /* Using a 0-terminated buffer:
Guido van Rossum98297ee2007-11-06 21:34:58 +00001192
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001193 - the encoded string has to be 0-terminated
1194 for this variant to work; if it is not, an
Guido van Rossum98297ee2007-11-06 21:34:58 +00001195 error raised
Fred Drake25871c02000-05-03 15:17:02 +00001196
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001197 - a new buffer of the needed size is
1198 allocated and the data copied into it;
1199 *buffer is updated to point to the new
1200 buffer; the caller is responsible for
1201 PyMem_Free()ing it after usage
1202
1203 */
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001204 if ((Py_ssize_t)strlen(ptr) != size) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001205 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001206 return converterr(
Benjamin Petersonef3e4c22009-04-11 19:48:14 +00001207 "encoded string without NULL bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001208 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001209 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001210 *buffer = PyMem_NEW(char, size + 1);
1211 if (*buffer == NULL) {
1212 Py_DECREF(s);
1213 return converterr("(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001214 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001215 }
Antoine Pitrouf71995782008-08-29 18:37:05 +00001216 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001217 Py_DECREF(s);
1218 return converterr("(cleanup problem)",
1219 arg, msgbuf, bufsize);
1220 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001221 memcpy(*buffer, ptr, size+1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001222 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001223 Py_DECREF(s);
1224 break;
1225 }
1226
1227 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001228 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1229 if (!PyUnicode_Check(arg))
1230 return converterr("str", arg, msgbuf, bufsize);
1231 *p = PyUnicode_AS_UNICODE(arg);
1232 if (*format == '#') { /* store pointer and size */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001233 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001234 STORE_SIZE(PyUnicode_GET_SIZE(arg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001235 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001236 }
1237 break;
1238 }
1239
Christian Heimes72b710a2008-05-26 13:28:38 +00001240 case 'S': { /* PyBytes object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001241 PyObject **p = va_arg(*p_va, PyObject **);
Christian Heimes72b710a2008-05-26 13:28:38 +00001242 if (PyBytes_Check(arg))
Guido van Rossum617dbc42007-05-07 23:57:08 +00001243 *p = arg;
1244 else
1245 return converterr("bytes", arg, msgbuf, bufsize);
1246 break;
1247 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001248
Christian Heimes9c4756e2008-05-26 13:22:05 +00001249 case 'Y': { /* PyByteArray object */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001250 PyObject **p = va_arg(*p_va, PyObject **);
Christian Heimes9c4756e2008-05-26 13:22:05 +00001251 if (PyByteArray_Check(arg))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001252 *p = arg;
1253 else
1254 return converterr("buffer", arg, msgbuf, bufsize);
1255 break;
1256 }
1257
1258 case 'U': { /* PyUnicode object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001259 PyObject **p = va_arg(*p_va, PyObject **);
1260 if (PyUnicode_Check(arg))
1261 *p = arg;
1262 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001263 return converterr("str", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001264 break;
1265 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001266
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001267 case 'O': { /* object */
1268 PyTypeObject *type;
1269 PyObject **p;
1270 if (*format == '!') {
1271 type = va_arg(*p_va, PyTypeObject*);
1272 p = va_arg(*p_va, PyObject **);
1273 format++;
Guido van Rossumcbfc8552001-08-28 16:37:51 +00001274 if (PyType_IsSubtype(arg->ob_type, type))
Guido van Rossume826ef02000-03-10 23:02:17 +00001275 *p = arg;
1276 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001277 return converterr(type->tp_name, arg, msgbuf, bufsize);
Guido van Rossumfccfe891998-05-15 22:04:07 +00001278
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001279 }
1280 else if (*format == '?') {
1281 inquiry pred = va_arg(*p_va, inquiry);
1282 p = va_arg(*p_va, PyObject **);
1283 format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001284 if ((*pred)(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001285 *p = arg;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001286 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001287 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001288 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001289
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001290 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001291 else if (*format == '&') {
1292 typedef int (*converter)(PyObject *, void *);
1293 converter convert = va_arg(*p_va, converter);
1294 void *addr = va_arg(*p_va, void *);
Martin v. Löwisc15bdef2009-05-29 14:47:46 +00001295 int res;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001296 format++;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +00001297 if (! (res = (*convert)(arg, addr)))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001298 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001299 arg, msgbuf, bufsize);
Martin v. Löwisc15bdef2009-05-29 14:47:46 +00001300 if (res == Py_CLEANUP_SUPPORTED &&
1301 addcleanup_convert(addr, freelist, convert) == -1)
1302 return converterr("(cleanup problem)",
1303 arg, msgbuf, bufsize);
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001304 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001305 else {
1306 p = va_arg(*p_va, PyObject **);
1307 *p = arg;
1308 }
1309 break;
1310 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001311
1312
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001313 case 'w': { /* memory buffer, read-write access */
1314 void **p = va_arg(*p_va, void **);
1315 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Christian Heimes4e30a842007-11-30 22:12:06 +00001316 Py_ssize_t count;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001317 int temp=-1;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001318 Py_buffer view;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001319
Martin v. Löwis423be952008-08-13 15:53:07 +00001320 if (pb && pb->bf_releasebuffer && *format != '*')
1321 /* Buffer must be released, yet caller does not use
1322 the Py_buffer protocol. */
1323 return converterr("pinned buffer", arg, msgbuf, bufsize);
1324
1325
1326 if (pb && pb->bf_getbuffer && *format == '*') {
1327 /* Caller is interested in Py_buffer, and the object
1328 supports it directly. */
1329 format++;
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001330 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
Martin v. Löwis423be952008-08-13 15:53:07 +00001331 PyErr_Clear();
1332 return converterr("read-write buffer", arg, msgbuf, bufsize);
1333 }
Antoine Pitrouf71995782008-08-29 18:37:05 +00001334 if (addcleanup(p, freelist, cleanup_buffer)) {
1335 return converterr(
1336 "(cleanup problem)",
1337 arg, msgbuf, bufsize);
1338 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001339 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C'))
1340 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1341 break;
1342 }
1343
1344 /* Here we have processed w*, only w and w# remain. */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001345 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001346 pb->bf_getbuffer == NULL ||
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001347 ((temp = PyObject_GetBuffer(arg, &view,
1348 PyBUF_SIMPLE)) != 0) ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001349 view.readonly == 1) {
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001350 if (temp==0) {
1351 PyBuffer_Release(&view);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001352 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001353 return converterr("single-segment read-write buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001354 arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001355 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001356
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001357 if ((count = view.len) < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001358 return converterr("(unspecified)", arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001359 *p = view.buf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001360 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001361 FETCH_SIZE;
1362 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001363 format++;
1364 }
1365 break;
1366 }
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001367
1368 /*TEO: This can be eliminated --- here only for backward
1369 compatibility */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001370 case 't': { /* 8-bit character buffer, read-only access */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001371 char **p = va_arg(*p_va, char **);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001372 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Christian Heimes4e30a842007-11-30 22:12:06 +00001373 Py_ssize_t count;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001374 Py_buffer view;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001375
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001376 if (*format++ != '#')
1377 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001378 "invalid use of 't' format character",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001379 arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001380 if (pb == NULL || pb->bf_getbuffer == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001381 return converterr(
Alexandre Vassalotti70a23712007-10-14 02:05:51 +00001382 "bytes or read-only character buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001383 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001384
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001385 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001386 return converterr("string or single-segment read-only buffer",
1387 arg, msgbuf, bufsize);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001388
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001389 count = view.len;
1390 *p = view.buf;
Martin v. Löwis423be952008-08-13 15:53:07 +00001391 if (pb->bf_releasebuffer)
1392 return converterr(
1393 "string or pinned buffer",
1394 arg, msgbuf, bufsize);
1395
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001396 PyBuffer_Release(&view);
1397
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001398 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001399 return converterr("(unspecified)", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001400 {
1401 FETCH_SIZE;
1402 STORE_SIZE(count);
1403 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001404 break;
1405 }
1406
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001407 default:
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001408 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001409
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001410 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001411
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001412 *p_format = format;
1413 return NULL;
1414}
Guido van Rossumaa354651996-08-19 19:32:04 +00001415
Martin v. Löwis18e16552006-02-15 17:27:45 +00001416static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001417convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001418{
1419 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001420 Py_ssize_t count;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001421 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001422
1423 *errmsg = NULL;
1424 *p = NULL;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001425 if (pb == NULL ||
Martin v. Löwis423be952008-08-13 15:53:07 +00001426 pb->bf_getbuffer == NULL ||
1427 pb->bf_releasebuffer != NULL) {
Guido van Rossumb0834002007-11-21 21:53:51 +00001428 *errmsg = "bytes or read-only buffer";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001429 return -1;
1430 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001431
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001432 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0) {
Guido van Rossumb0834002007-11-21 21:53:51 +00001433 *errmsg = "bytes or single-segment read-only buffer";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001434 return -1;
1435 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001436 count = view.len;
1437 *p = view.buf;
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001438 PyBuffer_Release(&view);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001439 return count;
1440}
Guido van Rossumaa354651996-08-19 19:32:04 +00001441
Martin v. Löwis423be952008-08-13 15:53:07 +00001442/* XXX for 3.x, getbuffer and convertbuffer can probably
1443 be merged again. */
1444static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001445getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001446{
1447 void *buf;
1448 Py_ssize_t count;
1449 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1450 if (pb == NULL) {
Benjamin Peterson81d90a22008-12-27 02:58:34 +00001451 *errmsg = "bytes or buffer";
Martin v. Löwis423be952008-08-13 15:53:07 +00001452 return -1;
1453 }
1454 if (pb->bf_getbuffer) {
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001455 if (PyObject_GetBuffer(arg, view, 0) < 0) {
Neal Norwitz2f99b242008-08-24 05:48:10 +00001456 *errmsg = "convertible to a buffer";
Martin v. Löwis423be952008-08-13 15:53:07 +00001457 return -1;
Neal Norwitz2f99b242008-08-24 05:48:10 +00001458 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001459 if (!PyBuffer_IsContiguous(view, 'C')) {
1460 *errmsg = "contiguous buffer";
1461 return -1;
1462 }
1463 return 0;
1464 }
1465
1466 count = convertbuffer(arg, &buf, errmsg);
Neal Norwitz2f99b242008-08-24 05:48:10 +00001467 if (count < 0) {
1468 *errmsg = "convertible to a buffer";
Martin v. Löwis423be952008-08-13 15:53:07 +00001469 return count;
Neal Norwitz2f99b242008-08-24 05:48:10 +00001470 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001471 PyBuffer_FillInfo(view, NULL, buf, count, 1, 0);
1472 return 0;
1473}
1474
Guido van Rossumaa354651996-08-19 19:32:04 +00001475/* Support for keyword arguments donated by
1476 Geoff Philbrick <philbric@delphi.hks.com> */
1477
Tim Petersf8cd3e82001-10-27 04:26:57 +00001478/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001479int
1480PyArg_ParseTupleAndKeywords(PyObject *args,
1481 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001482 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001483 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001484{
1485 int retval;
1486 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001487
1488 if ((args == NULL || !PyTuple_Check(args)) ||
1489 (keywords != NULL && !PyDict_Check(keywords)) ||
1490 format == NULL ||
1491 kwlist == NULL)
1492 {
1493 PyErr_BadInternalCall();
Tim Petersf8cd3e82001-10-27 04:26:57 +00001494 return 0;
Tim Peters45772cd2001-10-27 03:58:40 +00001495 }
1496
Guido van Rossumaa354651996-08-19 19:32:04 +00001497 va_start(va, kwlist);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001498 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001499 va_end(va);
1500 return retval;
1501}
1502
1503int
1504_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1505 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001506 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001507 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001508{
1509 int retval;
1510 va_list va;
1511
1512 if ((args == NULL || !PyTuple_Check(args)) ||
1513 (keywords != NULL && !PyDict_Check(keywords)) ||
1514 format == NULL ||
1515 kwlist == NULL)
1516 {
1517 PyErr_BadInternalCall();
1518 return 0;
1519 }
1520
1521 va_start(va, kwlist);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001522 retval = vgetargskeywords(args, keywords, format,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001523 kwlist, &va, FLAG_SIZE_T);
Guido van Rossumaa354651996-08-19 19:32:04 +00001524 va_end(va);
1525 return retval;
1526}
1527
1528
Brett Cannon711e7d92004-07-10 22:20:32 +00001529int
1530PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001531 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001532 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001533 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001534{
1535 int retval;
1536 va_list lva;
1537
1538 if ((args == NULL || !PyTuple_Check(args)) ||
1539 (keywords != NULL && !PyDict_Check(keywords)) ||
1540 format == NULL ||
1541 kwlist == NULL)
1542 {
1543 PyErr_BadInternalCall();
1544 return 0;
1545 }
1546
1547#ifdef VA_LIST_IS_ARRAY
1548 memcpy(lva, va, sizeof(va_list));
1549#else
1550#ifdef __va_copy
1551 __va_copy(lva, va);
1552#else
1553 lva = va;
1554#endif
1555#endif
1556
Guido van Rossum98297ee2007-11-06 21:34:58 +00001557 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001558 return retval;
1559}
1560
1561int
1562_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1563 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001564 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001565 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001566{
1567 int retval;
1568 va_list lva;
1569
1570 if ((args == NULL || !PyTuple_Check(args)) ||
1571 (keywords != NULL && !PyDict_Check(keywords)) ||
1572 format == NULL ||
1573 kwlist == NULL)
1574 {
1575 PyErr_BadInternalCall();
1576 return 0;
1577 }
1578
1579#ifdef VA_LIST_IS_ARRAY
1580 memcpy(lva, va, sizeof(va_list));
1581#else
1582#ifdef __va_copy
1583 __va_copy(lva, va);
1584#else
1585 lva = va;
1586#endif
1587#endif
1588
Guido van Rossum98297ee2007-11-06 21:34:58 +00001589 retval = vgetargskeywords(args, keywords, format,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001590 kwlist, &lva, FLAG_SIZE_T);
Brett Cannon711e7d92004-07-10 22:20:32 +00001591 return retval;
1592}
1593
Christian Heimes380f7f22008-02-28 11:19:05 +00001594#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001595
Guido van Rossumaa354651996-08-19 19:32:04 +00001596static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001597vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001598 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001599{
Tim Petersdc5eff92001-10-27 06:53:00 +00001600 char msgbuf[512];
Guido van Rossumaa354651996-08-19 19:32:04 +00001601 int levels[32];
Christian Heimes380f7f22008-02-28 11:19:05 +00001602 const char *fname, *msg, *custom_msg, *keyword;
1603 int min = INT_MAX;
Tim Petersb639d492001-10-27 07:00:56 +00001604 int i, len, nargs, nkeywords;
Christian Heimes380f7f22008-02-28 11:19:05 +00001605 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001606
Tim Peters45772cd2001-10-27 03:58:40 +00001607 assert(args != NULL && PyTuple_Check(args));
1608 assert(keywords == NULL || PyDict_Check(keywords));
1609 assert(format != NULL);
1610 assert(kwlist != NULL);
1611 assert(p_va != NULL);
1612
Christian Heimes380f7f22008-02-28 11:19:05 +00001613 /* grab the function name or custom error msg first (mutually exclusive) */
1614 fname = strchr(format, ':');
1615 if (fname) {
1616 fname++;
1617 custom_msg = NULL;
Tim Peters62d48e12001-10-27 06:42:16 +00001618 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001619 else {
1620 custom_msg = strchr(format,';');
1621 if (custom_msg)
1622 custom_msg++;
Tim Peters62d48e12001-10-27 06:42:16 +00001623 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001624
1625 /* scan kwlist and get greatest possible nbr of args */
1626 for (len=0; kwlist[len]; len++)
1627 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001628
Tim Peters6fb26352001-10-27 04:38:11 +00001629 nargs = PyTuple_GET_SIZE(args);
Christian Heimes380f7f22008-02-28 11:19:05 +00001630 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1631 if (nargs + nkeywords > len) {
1632 PyErr_Format(PyExc_TypeError, "%s%s takes at most %d "
1633 "argument%s (%d given)",
1634 (fname == NULL) ? "function" : fname,
1635 (fname == NULL) ? "" : "()",
1636 len,
1637 (len == 1) ? "" : "s",
1638 nargs + nkeywords);
Guido van Rossumaa354651996-08-19 19:32:04 +00001639 return 0;
1640 }
Tim Petersc2f01122001-10-27 07:25:06 +00001641
Christian Heimes380f7f22008-02-28 11:19:05 +00001642 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1643 for (i = 0; i < len; i++) {
1644 keyword = kwlist[i];
1645 if (*format == '|') {
1646 min = i;
Guido van Rossumaa354651996-08-19 19:32:04 +00001647 format++;
Christian Heimes380f7f22008-02-28 11:19:05 +00001648 }
1649 if (IS_END_OF_FORMAT(*format)) {
1650 PyErr_Format(PyExc_RuntimeError,
1651 "More keyword list entries (%d) than "
1652 "format specifiers (%d)", len, i);
1653 return cleanreturn(0, freelist);
1654 }
1655 current_arg = NULL;
1656 if (nkeywords) {
1657 current_arg = PyDict_GetItemString(keywords, keyword);
1658 }
1659 if (current_arg) {
1660 --nkeywords;
1661 if (i < nargs) {
1662 /* arg present in tuple and in dict */
1663 PyErr_Format(PyExc_TypeError,
1664 "Argument given by name ('%s') "
1665 "and position (%d)",
1666 keyword, i+1);
1667 return cleanreturn(0, freelist);
1668 }
1669 }
1670 else if (nkeywords && PyErr_Occurred())
1671 return cleanreturn(0, freelist);
1672 else if (i < nargs)
1673 current_arg = PyTuple_GET_ITEM(args, i);
1674
1675 if (current_arg) {
1676 msg = convertitem(current_arg, &format, p_va, flags,
1677 levels, msgbuf, sizeof(msgbuf), &freelist);
1678 if (msg) {
1679 seterror(i+1, msg, levels, fname, custom_msg);
1680 return cleanreturn(0, freelist);
1681 }
1682 continue;
1683 }
1684
1685 if (i < min) {
1686 PyErr_Format(PyExc_TypeError, "Required argument "
1687 "'%s' (pos %d) not found",
1688 keyword, i+1);
1689 return cleanreturn(0, freelist);
1690 }
1691 /* current code reports success when all required args
1692 * fulfilled and no keyword args left, with no further
1693 * validation. XXX Maybe skip this in debug build ?
1694 */
1695 if (!nkeywords)
1696 return cleanreturn(1, freelist);
1697
1698 /* We are into optional args, skip thru to any remaining
1699 * keyword args */
1700 msg = skipitem(&format, p_va, flags);
Guido van Rossumaa354651996-08-19 19:32:04 +00001701 if (msg) {
Christian Heimes380f7f22008-02-28 11:19:05 +00001702 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1703 format);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001704 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001705 }
1706 }
1707
Benjamin Peterson92035012008-12-27 16:00:54 +00001708 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
Christian Heimes380f7f22008-02-28 11:19:05 +00001709 PyErr_Format(PyExc_RuntimeError,
1710 "more argument specifiers than keyword list entries "
1711 "(remaining format:'%s')", format);
1712 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001713 }
Tim Petersb054be42001-10-27 05:07:41 +00001714
Guido van Rossumaa354651996-08-19 19:32:04 +00001715 /* make sure there are no extraneous keyword arguments */
Tim Petersc2f01122001-10-27 07:25:06 +00001716 if (nkeywords > 0) {
1717 PyObject *key, *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001718 Py_ssize_t pos = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001719 while (PyDict_Next(keywords, &pos, &key, &value)) {
Tim Petersc2f01122001-10-27 07:25:06 +00001720 int match = 0;
Guido van Rossum55474762002-04-04 16:22:30 +00001721 char *ks;
Georg Brandld8b690f2008-05-16 17:28:50 +00001722 if (!PyUnicode_Check(key)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00001723 PyErr_SetString(PyExc_TypeError,
Guido van Rossum55474762002-04-04 16:22:30 +00001724 "keywords must be strings");
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001725 return cleanreturn(0, freelist);
Guido van Rossum55474762002-04-04 16:22:30 +00001726 }
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001727 ks = _PyUnicode_AsString(key);
Christian Heimes380f7f22008-02-28 11:19:05 +00001728 for (i = 0; i < len; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001729 if (!strcmp(ks, kwlist[i])) {
1730 match = 1;
1731 break;
1732 }
1733 }
1734 if (!match) {
Tim Petersc2f01122001-10-27 07:25:06 +00001735 PyErr_Format(PyExc_TypeError,
1736 "'%s' is an invalid keyword "
1737 "argument for this function",
1738 ks);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001739 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001740 }
1741 }
1742 }
Tim Petersc2f01122001-10-27 07:25:06 +00001743
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001744 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001745}
1746
1747
1748static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001749skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001750{
Christian Heimes380f7f22008-02-28 11:19:05 +00001751 const char *format = *p_format;
Guido van Rossumaa354651996-08-19 19:32:04 +00001752 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001753
Guido van Rossumaa354651996-08-19 19:32:04 +00001754 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001755
1756 /* simple codes
1757 * The individual types (second arg of va_arg) are irrelevant */
1758
Guido van Rossumaa354651996-08-19 19:32:04 +00001759 case 'b': /* byte -- very short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001760 case 'B': /* byte as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001761 case 'h': /* short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001762 case 'H': /* short int as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001763 case 'i': /* int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001764 case 'I': /* int sized bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001765 case 'l': /* long int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001766 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001767#ifdef HAVE_LONG_LONG
Georg Brandl6dd14612005-09-14 19:29:53 +00001768 case 'L': /* PY_LONG_LONG */
1769 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001770#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001771 case 'f': /* float */
Guido van Rossumaa354651996-08-19 19:32:04 +00001772 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001773 case 'D': /* complex double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001774 case 'c': /* char */
Mark Dickinsonf08173b2009-12-03 10:59:46 +00001775 case 'C': /* unicode char */
Guido van Rossumaa354651996-08-19 19:32:04 +00001776 {
Georg Brandl6dd14612005-09-14 19:29:53 +00001777 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001778 break;
1779 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001780
1781 case 'n': /* Py_ssize_t */
1782 {
1783 (void) va_arg(*p_va, Py_ssize_t *);
1784 break;
1785 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001786
Georg Brandl6dd14612005-09-14 19:29:53 +00001787 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001788
Georg Brandl6dd14612005-09-14 19:29:53 +00001789 case 'e': /* string with encoding */
1790 {
1791 (void) va_arg(*p_va, const char *);
1792 if (!(*format == 's' || *format == 't'))
1793 /* after 'e', only 's' and 't' is allowed */
1794 goto err;
1795 format++;
1796 /* explicit fallthrough to string cases */
1797 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001798
Guido van Rossumaa354651996-08-19 19:32:04 +00001799 case 's': /* string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001800 case 'z': /* string or None */
Walter Dörwald612344f2007-05-04 19:28:21 +00001801 case 'y': /* bytes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001802 case 'u': /* unicode string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001803 case 't': /* buffer, read-only */
1804 case 'w': /* buffer, read-write */
Guido van Rossumaa354651996-08-19 19:32:04 +00001805 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001806 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001807 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001808 if (flags & FLAG_SIZE_T)
1809 (void) va_arg(*p_va, Py_ssize_t *);
1810 else
1811 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001812 format++;
Martin v. Löwis423be952008-08-13 15:53:07 +00001813 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1814 format++;
Guido van Rossumaa354651996-08-19 19:32:04 +00001815 }
1816 break;
1817 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001818
1819 /* object codes */
1820
Guido van Rossumaa354651996-08-19 19:32:04 +00001821 case 'S': /* string object */
Guido van Rossum617dbc42007-05-07 23:57:08 +00001822 case 'Y': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001823 case 'U': /* unicode string object */
Guido van Rossumaa354651996-08-19 19:32:04 +00001824 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001825 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001826 break;
1827 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001828
Guido van Rossumaa354651996-08-19 19:32:04 +00001829 case 'O': /* object */
1830 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001831 if (*format == '!') {
1832 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001833 (void) va_arg(*p_va, PyTypeObject*);
1834 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001835 }
1836#if 0
1837/* I don't know what this is for */
1838 else if (*format == '?') {
1839 inquiry pred = va_arg(*p_va, inquiry);
1840 format++;
1841 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001842 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001843 }
1844 }
1845#endif
1846 else if (*format == '&') {
Tim Petersdbd9ba62000-07-09 03:09:57 +00001847 typedef int (*converter)(PyObject *, void *);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001848 (void) va_arg(*p_va, converter);
1849 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001850 format++;
1851 }
1852 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001853 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001854 }
1855 break;
1856 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001857
Christian Heimes380f7f22008-02-28 11:19:05 +00001858 case '(': /* bypass tuple, not handled at all previously */
1859 {
1860 char *msg;
1861 for (;;) {
1862 if (*format==')')
1863 break;
1864 if (IS_END_OF_FORMAT(*format))
1865 return "Unmatched left paren in format "
1866 "string";
1867 msg = skipitem(&format, p_va, flags);
1868 if (msg)
1869 return msg;
1870 }
1871 format++;
1872 break;
1873 }
1874
1875 case ')':
1876 return "Unmatched right paren in format string";
1877
Guido van Rossumaa354651996-08-19 19:32:04 +00001878 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001879err:
Guido van Rossumaa354651996-08-19 19:32:04 +00001880 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001881
Guido van Rossumaa354651996-08-19 19:32:04 +00001882 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001883
Guido van Rossumaa354651996-08-19 19:32:04 +00001884 *p_format = format;
1885 return NULL;
1886}
Fred Drakee4616e62001-10-23 21:09:29 +00001887
1888
1889int
Martin v. Löwis76246742006-03-01 04:06:10 +00001890PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001891{
Martin v. Löwis76246742006-03-01 04:06:10 +00001892 Py_ssize_t i, l;
Fred Drakee4616e62001-10-23 21:09:29 +00001893 PyObject **o;
1894 va_list vargs;
1895
1896#ifdef HAVE_STDARG_PROTOTYPES
1897 va_start(vargs, max);
1898#else
1899 va_start(vargs);
1900#endif
1901
1902 assert(min >= 0);
1903 assert(min <= max);
1904 if (!PyTuple_Check(args)) {
1905 PyErr_SetString(PyExc_SystemError,
1906 "PyArg_UnpackTuple() argument list is not a tuple");
1907 return 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001908 }
Fred Drakee4616e62001-10-23 21:09:29 +00001909 l = PyTuple_GET_SIZE(args);
1910 if (l < min) {
1911 if (name != NULL)
1912 PyErr_Format(
1913 PyExc_TypeError,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001914 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001915 name, (min == max ? "" : "at least "), min, l);
1916 else
1917 PyErr_Format(
1918 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001919 "unpacked tuple should have %s%zd elements,"
Guido van Rossum98297ee2007-11-06 21:34:58 +00001920 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001921 (min == max ? "" : "at least "), min, l);
1922 va_end(vargs);
1923 return 0;
1924 }
1925 if (l > max) {
1926 if (name != NULL)
1927 PyErr_Format(
1928 PyExc_TypeError,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001929 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001930 name, (min == max ? "" : "at most "), max, l);
1931 else
1932 PyErr_Format(
1933 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001934 "unpacked tuple should have %s%zd elements,"
Guido van Rossum98297ee2007-11-06 21:34:58 +00001935 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001936 (min == max ? "" : "at most "), max, l);
1937 va_end(vargs);
1938 return 0;
1939 }
1940 for (i = 0; i < l; i++) {
1941 o = va_arg(vargs, PyObject **);
1942 *o = PyTuple_GET_ITEM(args, i);
1943 }
1944 va_end(vargs);
1945 return 1;
1946}
Georg Brandl02c42872005-08-26 06:42:30 +00001947
1948
1949/* For type constructors that don't take keyword args
1950 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001951 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001952 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001953 */
1954int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001955_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001956{
1957 if (kw == NULL)
1958 return 1;
1959 if (!PyDict_CheckExact(kw)) {
1960 PyErr_BadInternalCall();
1961 return 0;
1962 }
1963 if (PyDict_Size(kw) == 0)
1964 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001965
1966 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
Georg Brandl02c42872005-08-26 06:42:30 +00001967 funcname);
1968 return 0;
1969}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001970#ifdef __cplusplus
1971};
1972#endif