blob: a5dc3602b2b7ce487363f4c5aa407ce834b9610e [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) {
390 seterror(i+1, msg, levels, fname, message);
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
Guido van Rossum530956d1996-07-21 02:27:43 +0000821#ifndef WITHOUT_COMPLEX
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000822 case 'D': {/* complex double */
823 Py_complex *p = va_arg(*p_va, Py_complex *);
824 Py_complex cval;
825 cval = PyComplex_AsCComplex(arg);
826 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000827 return converterr("complex<D>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000828 else
829 *p = cval;
830 break;
831 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000832#endif /* WITHOUT_COMPLEX */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000833
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000834 case 'c': {/* char */
Walter Dörwaldd0941302007-07-01 21:58:22 +0000835 char *p = va_arg(*p_va, char *);
Christian Heimes72b710a2008-05-26 13:28:38 +0000836 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
837 *p = PyBytes_AS_STRING(arg)[0];
Walter Dörwaldd0941302007-07-01 21:58:22 +0000838 else
Benjamin Peterson7fe98532009-04-02 00:33:55 +0000839 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
Walter Dörwaldd0941302007-07-01 21:58:22 +0000840 break;
841 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000842
Walter Dörwaldd0941302007-07-01 21:58:22 +0000843 case 'C': {/* unicode char */
Walter Dörwaldbc1f8862007-06-20 11:02:38 +0000844 int *p = va_arg(*p_va, int *);
Benjamin Peterson7fe98532009-04-02 00:33:55 +0000845 if (PyUnicode_Check(arg) &&
846 PyUnicode_GET_SIZE(arg) == 1)
Guido van Rossum09dc34f2007-05-04 04:17:33 +0000847 *p = PyUnicode_AS_UNICODE(arg)[0];
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000848 else
Benjamin Peterson7fe98532009-04-02 00:33:55 +0000849 return converterr("a unicode character", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000850 break;
851 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000852
853 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w', 't' codes all
854 need to be cleaned up! */
855
856 case 's': {/* text string */
Martin v. Löwis423be952008-08-13 15:53:07 +0000857 if (*format == '*') {
858 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
859
860 if (PyUnicode_Check(arg)) {
861 uarg = UNICODE_DEFAULT_ENCODING(arg);
862 if (uarg == NULL)
863 return converterr(CONV_UNICODE,
864 arg, msgbuf, bufsize);
865 PyBuffer_FillInfo(p, arg,
866 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
867 1, 0);
868 }
869 else { /* any buffer-like object */
870 char *buf;
871 if (getbuffer(arg, p, &buf) < 0)
872 return converterr(buf, arg, msgbuf, bufsize);
873 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000874 if (addcleanup(p, freelist, cleanup_buffer)) {
875 return converterr(
876 "(cleanup problem)",
877 arg, msgbuf, bufsize);
878 }
Martin v. Löwis423be952008-08-13 15:53:07 +0000879 format++;
880 } else if (*format == '#') {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000881 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000882 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000883
884 if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000885 uarg = UNICODE_DEFAULT_ENCODING(arg);
886 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000887 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000888 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000889 *p = PyBytes_AS_STRING(uarg);
890 STORE_SIZE(PyBytes_GET_SIZE(uarg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000891 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000892 else { /* any buffer-like object */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000893 /* XXX Really? */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000894 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000895 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000896 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000897 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000898 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000899 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000900 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000901 } else {
902 char **p = va_arg(*p_va, char **);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000903
904 if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000905 uarg = UNICODE_DEFAULT_ENCODING(arg);
906 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000907 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000908 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000909 *p = PyBytes_AS_STRING(uarg);
Marc-André Lemburg6f15e572001-05-02 17:16:16 +0000910 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000911 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000912 return converterr("string", arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000913 if ((Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000914 return converterr("string without null bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000915 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000916 }
917 break;
918 }
919
Guido van Rossum98297ee2007-11-06 21:34:58 +0000920 case 'y': {/* any buffer-like object, but not PyUnicode */
921 void **p = (void **)va_arg(*p_va, char **);
922 char *buf;
Martin v. Löwis423be952008-08-13 15:53:07 +0000923 Py_ssize_t count;
924 if (*format == '*') {
925 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
926 return converterr(buf, arg, msgbuf, bufsize);
927 format++;
Antoine Pitrouf71995782008-08-29 18:37:05 +0000928 if (addcleanup(p, freelist, cleanup_buffer)) {
929 return converterr(
930 "(cleanup problem)",
931 arg, msgbuf, bufsize);
932 }
Martin v. Löwis423be952008-08-13 15:53:07 +0000933 break;
934 }
935 count = convertbuffer(arg, p, &buf);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000936 if (count < 0)
937 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis423be952008-08-13 15:53:07 +0000938 else if (*format == '#') {
Walter Dörwald612344f2007-05-04 19:28:21 +0000939 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000940 STORE_SIZE(count);
Walter Dörwald612344f2007-05-04 19:28:21 +0000941 format++;
Walter Dörwald612344f2007-05-04 19:28:21 +0000942 }
943 break;
944 }
945
Guido van Rossum98297ee2007-11-06 21:34:58 +0000946 case 'z': {/* like 's' or 's#', but None is okay, stored as NULL */
Martin v. Löwis423be952008-08-13 15:53:07 +0000947 if (*format == '*') {
948 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
949
950 if (arg == Py_None)
951 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
952 else if (PyUnicode_Check(arg)) {
953 uarg = UNICODE_DEFAULT_ENCODING(arg);
954 if (uarg == NULL)
955 return converterr(CONV_UNICODE,
956 arg, msgbuf, bufsize);
957 PyBuffer_FillInfo(p, arg,
958 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
959 1, 0);
960 }
961 else { /* any buffer-like object */
962 char *buf;
963 if (getbuffer(arg, p, &buf) < 0)
964 return converterr(buf, arg, msgbuf, bufsize);
965 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000966 if (addcleanup(p, freelist, cleanup_buffer)) {
967 return converterr(
968 "(cleanup problem)",
969 arg, msgbuf, bufsize);
970 }
Martin v. Löwis423be952008-08-13 15:53:07 +0000971 format++;
972 } else if (*format == '#') { /* any buffer-like object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000973 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000974 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000975
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000976 if (arg == Py_None) {
977 *p = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000978 STORE_SIZE(0);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000979 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000980 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000981 uarg = UNICODE_DEFAULT_ENCODING(arg);
982 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000983 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000984 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000985 *p = PyBytes_AS_STRING(uarg);
986 STORE_SIZE(PyBytes_GET_SIZE(uarg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000987 }
988 else { /* any buffer-like object */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000989 /* XXX Really? */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000990 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000991 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000992 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000993 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000994 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000995 }
996 format++;
997 } else {
998 char **p = va_arg(*p_va, char **);
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +0000999 uarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001000
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001001 if (arg == Py_None)
1002 *p = 0;
Christian Heimes72b710a2008-05-26 13:28:38 +00001003 else if (PyBytes_Check(arg)) {
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +00001004 /* Enable null byte check below */
1005 uarg = arg;
Christian Heimes72b710a2008-05-26 13:28:38 +00001006 *p = PyBytes_AS_STRING(arg);
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +00001007 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001008 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +00001009 uarg = UNICODE_DEFAULT_ENCODING(arg);
1010 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001011 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001012 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +00001013 *p = PyBytes_AS_STRING(uarg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001014 }
1015 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001016 return converterr("string or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001017 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001018 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001019 FETCH_SIZE;
Thomas Woutersc3547a32006-03-01 21:31:21 +00001020 assert(0); /* XXX redundant with if-case */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001021 if (arg == Py_None) {
1022 STORE_SIZE(0);
1023 }
1024 else {
Christian Heimes72b710a2008-05-26 13:28:38 +00001025 STORE_SIZE(PyBytes_Size(arg));
Guido van Rossum98297ee2007-11-06 21:34:58 +00001026 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001027 format++;
1028 }
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +00001029 else if (*p != NULL && uarg != NULL &&
Christian Heimes72b710a2008-05-26 13:28:38 +00001030 (Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001031 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001032 "string without null bytes or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001033 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001034 }
1035 break;
1036 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001037
Guido van Rossumfb67be22007-08-29 18:38:11 +00001038 case 'Z': {/* unicode, may be NULL (None) */
1039 if (*format == '#') { /* any buffer-like object */
1040 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1041 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001042
Guido van Rossumfb67be22007-08-29 18:38:11 +00001043 if (arg == Py_None) {
1044 *p = 0;
1045 STORE_SIZE(0);
1046 }
1047 else if (PyUnicode_Check(arg)) {
1048 *p = PyUnicode_AS_UNICODE(arg);
1049 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1050 }
1051 format++;
1052 } else {
1053 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001054
Guido van Rossumfb67be22007-08-29 18:38:11 +00001055 if (arg == Py_None)
1056 *p = 0;
1057 else if (PyUnicode_Check(arg))
1058 *p = PyUnicode_AS_UNICODE(arg);
1059 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001060 return converterr("string or None",
Guido van Rossumfb67be22007-08-29 18:38:11 +00001061 arg, msgbuf, bufsize);
1062 }
1063 break;
1064 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001065
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001066 case 'e': {/* encoded string */
1067 char **buffer;
1068 const char *encoding;
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001069 PyObject *s;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001070 int recode_strings;
1071 Py_ssize_t size;
Guido van Rossumd70539a2007-05-09 23:35:09 +00001072 const char *ptr;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001073
1074 /* Get 'e' parameter: the encoding name */
1075 encoding = (const char *)va_arg(*p_va, const char *);
1076 if (encoding == NULL)
1077 encoding = PyUnicode_GetDefaultEncoding();
Guido van Rossum98297ee2007-11-06 21:34:58 +00001078
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001079 /* Get output buffer parameter:
1080 's' (recode all objects via Unicode) or
Guido van Rossum98297ee2007-11-06 21:34:58 +00001081 't' (only recode non-string objects)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001082 */
1083 if (*format == 's')
1084 recode_strings = 1;
1085 else if (*format == 't')
1086 recode_strings = 0;
1087 else
1088 return converterr(
1089 "(unknown parser marker combination)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001090 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001091 buffer = (char **)va_arg(*p_va, char **);
1092 format++;
1093 if (buffer == NULL)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001094 return converterr("(buffer is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001095 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001096
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001097 /* Encode object */
Guido van Rossumd70539a2007-05-09 23:35:09 +00001098 if (!recode_strings &&
Christian Heimes72b710a2008-05-26 13:28:38 +00001099 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001100 s = arg;
1101 Py_INCREF(s);
Guido van Rossumd70539a2007-05-09 23:35:09 +00001102 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1103 return converterr("(AsCharBuffer failed)",
1104 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001105 }
1106 else {
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001107 PyObject *u;
1108
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001109 /* Convert object to Unicode */
1110 u = PyUnicode_FromObject(arg);
1111 if (u == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001112 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001113 "string or unicode or text buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001114 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001115
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001116 /* Encode object; use default error handling */
1117 s = PyUnicode_AsEncodedString(u,
1118 encoding,
1119 NULL);
1120 Py_DECREF(u);
1121 if (s == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001122 return converterr("(encoding failed)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001123 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +00001124 if (!PyBytes_Check(s)) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001125 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001126 return converterr(
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001127 "(encoder failed to return bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001128 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001129 }
Christian Heimes72b710a2008-05-26 13:28:38 +00001130 size = PyBytes_GET_SIZE(s);
1131 ptr = PyBytes_AS_STRING(s);
Guido van Rossumd70539a2007-05-09 23:35:09 +00001132 if (ptr == NULL)
1133 ptr = "";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001134 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001135
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001136 /* Write output; output is guaranteed to be 0-terminated */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001137 if (*format == '#') {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001138 /* Using buffer length parameter '#':
Guido van Rossum98297ee2007-11-06 21:34:58 +00001139
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001140 - if *buffer is NULL, a new buffer of the
1141 needed size is allocated and the data
1142 copied into it; *buffer is updated to point
1143 to the new buffer; the caller is
1144 responsible for PyMem_Free()ing it after
Guido van Rossum98297ee2007-11-06 21:34:58 +00001145 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001146
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001147 - if *buffer is not NULL, the data is
1148 copied to *buffer; *buffer_len has to be
1149 set to the size of the buffer on input;
1150 buffer overflow is signalled with an error;
1151 buffer has to provide enough room for the
1152 encoded string plus the trailing 0-byte
Guido van Rossum98297ee2007-11-06 21:34:58 +00001153
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001154 - in both cases, *buffer_len is updated to
1155 the size of the buffer /excluding/ the
Guido van Rossum98297ee2007-11-06 21:34:58 +00001156 trailing 0-byte
1157
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001158 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001159 FETCH_SIZE;
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001160
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001161 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001162 if (q == NULL && q2 == NULL) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001163 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001164 return converterr(
1165 "(buffer_len is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001166 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001167 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001168 if (*buffer == NULL) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001169 *buffer = PyMem_NEW(char, size + 1);
1170 if (*buffer == NULL) {
1171 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001172 return converterr(
1173 "(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001174 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001175 }
Antoine Pitrouf71995782008-08-29 18:37:05 +00001176 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001177 Py_DECREF(s);
1178 return converterr(
1179 "(cleanup problem)",
1180 arg, msgbuf, bufsize);
1181 }
Fred Drake25871c02000-05-03 15:17:02 +00001182 } else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001183 if (size + 1 > BUFFER_LEN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001184 Py_DECREF(s);
1185 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001186 "(buffer overflow)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001187 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001188 }
Fred Drake25871c02000-05-03 15:17:02 +00001189 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001190 memcpy(*buffer, ptr, size+1);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001191 STORE_SIZE(size);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001192 } else {
1193 /* Using a 0-terminated buffer:
Guido van Rossum98297ee2007-11-06 21:34:58 +00001194
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001195 - the encoded string has to be 0-terminated
1196 for this variant to work; if it is not, an
Guido van Rossum98297ee2007-11-06 21:34:58 +00001197 error raised
Fred Drake25871c02000-05-03 15:17:02 +00001198
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001199 - a new buffer of the needed size is
1200 allocated and the data copied into it;
1201 *buffer is updated to point to the new
1202 buffer; the caller is responsible for
1203 PyMem_Free()ing it after usage
1204
1205 */
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001206 if ((Py_ssize_t)strlen(ptr) != size) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001207 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001208 return converterr(
Benjamin Petersonef3e4c22009-04-11 19:48:14 +00001209 "encoded string without NULL bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001210 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001211 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001212 *buffer = PyMem_NEW(char, size + 1);
1213 if (*buffer == NULL) {
1214 Py_DECREF(s);
1215 return converterr("(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001216 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001217 }
Antoine Pitrouf71995782008-08-29 18:37:05 +00001218 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001219 Py_DECREF(s);
1220 return converterr("(cleanup problem)",
1221 arg, msgbuf, bufsize);
1222 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001223 memcpy(*buffer, ptr, size+1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001224 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001225 Py_DECREF(s);
1226 break;
1227 }
1228
1229 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001230 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1231 if (!PyUnicode_Check(arg))
1232 return converterr("str", arg, msgbuf, bufsize);
1233 *p = PyUnicode_AS_UNICODE(arg);
1234 if (*format == '#') { /* store pointer and size */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001235 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001236 STORE_SIZE(PyUnicode_GET_SIZE(arg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001237 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001238 }
1239 break;
1240 }
1241
Christian Heimes72b710a2008-05-26 13:28:38 +00001242 case 'S': { /* PyBytes object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001243 PyObject **p = va_arg(*p_va, PyObject **);
Christian Heimes72b710a2008-05-26 13:28:38 +00001244 if (PyBytes_Check(arg))
Guido van Rossum617dbc42007-05-07 23:57:08 +00001245 *p = arg;
1246 else
1247 return converterr("bytes", arg, msgbuf, bufsize);
1248 break;
1249 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001250
Christian Heimes9c4756e2008-05-26 13:22:05 +00001251 case 'Y': { /* PyByteArray object */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001252 PyObject **p = va_arg(*p_va, PyObject **);
Christian Heimes9c4756e2008-05-26 13:22:05 +00001253 if (PyByteArray_Check(arg))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001254 *p = arg;
1255 else
1256 return converterr("buffer", arg, msgbuf, bufsize);
1257 break;
1258 }
1259
1260 case 'U': { /* PyUnicode object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001261 PyObject **p = va_arg(*p_va, PyObject **);
1262 if (PyUnicode_Check(arg))
1263 *p = arg;
1264 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001265 return converterr("str", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001266 break;
1267 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001268
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001269 case 'O': { /* object */
1270 PyTypeObject *type;
1271 PyObject **p;
1272 if (*format == '!') {
1273 type = va_arg(*p_va, PyTypeObject*);
1274 p = va_arg(*p_va, PyObject **);
1275 format++;
Guido van Rossumcbfc8552001-08-28 16:37:51 +00001276 if (PyType_IsSubtype(arg->ob_type, type))
Guido van Rossume826ef02000-03-10 23:02:17 +00001277 *p = arg;
1278 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001279 return converterr(type->tp_name, arg, msgbuf, bufsize);
Guido van Rossumfccfe891998-05-15 22:04:07 +00001280
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001281 }
1282 else if (*format == '?') {
1283 inquiry pred = va_arg(*p_va, inquiry);
1284 p = va_arg(*p_va, PyObject **);
1285 format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001286 if ((*pred)(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001287 *p = arg;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001288 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001289 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001290 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001291
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001292 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001293 else if (*format == '&') {
1294 typedef int (*converter)(PyObject *, void *);
1295 converter convert = va_arg(*p_va, converter);
1296 void *addr = va_arg(*p_va, void *);
Martin v. Löwisc15bdef2009-05-29 14:47:46 +00001297 int res;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001298 format++;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +00001299 if (! (res = (*convert)(arg, addr)))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001300 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001301 arg, msgbuf, bufsize);
Martin v. Löwisc15bdef2009-05-29 14:47:46 +00001302 if (res == Py_CLEANUP_SUPPORTED &&
1303 addcleanup_convert(addr, freelist, convert) == -1)
1304 return converterr("(cleanup problem)",
1305 arg, msgbuf, bufsize);
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001306 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001307 else {
1308 p = va_arg(*p_va, PyObject **);
1309 *p = arg;
1310 }
1311 break;
1312 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001313
1314
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001315 case 'w': { /* memory buffer, read-write access */
1316 void **p = va_arg(*p_va, void **);
1317 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Christian Heimes4e30a842007-11-30 22:12:06 +00001318 Py_ssize_t count;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001319 int temp=-1;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001320 Py_buffer view;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001321
Martin v. Löwis423be952008-08-13 15:53:07 +00001322 if (pb && pb->bf_releasebuffer && *format != '*')
1323 /* Buffer must be released, yet caller does not use
1324 the Py_buffer protocol. */
1325 return converterr("pinned buffer", arg, msgbuf, bufsize);
1326
1327
1328 if (pb && pb->bf_getbuffer && *format == '*') {
1329 /* Caller is interested in Py_buffer, and the object
1330 supports it directly. */
1331 format++;
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001332 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
Martin v. Löwis423be952008-08-13 15:53:07 +00001333 PyErr_Clear();
1334 return converterr("read-write buffer", arg, msgbuf, bufsize);
1335 }
Antoine Pitrouf71995782008-08-29 18:37:05 +00001336 if (addcleanup(p, freelist, cleanup_buffer)) {
1337 return converterr(
1338 "(cleanup problem)",
1339 arg, msgbuf, bufsize);
1340 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001341 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C'))
1342 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1343 break;
1344 }
1345
1346 /* Here we have processed w*, only w and w# remain. */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001347 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001348 pb->bf_getbuffer == NULL ||
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001349 ((temp = PyObject_GetBuffer(arg, &view,
1350 PyBUF_SIMPLE)) != 0) ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001351 view.readonly == 1) {
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001352 if (temp==0) {
1353 PyBuffer_Release(&view);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001354 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001355 return converterr("single-segment read-write buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001356 arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001357 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001358
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001359 if ((count = view.len) < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001360 return converterr("(unspecified)", arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001361 *p = view.buf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001362 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001363 FETCH_SIZE;
1364 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001365 format++;
1366 }
1367 break;
1368 }
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001369
1370 /*TEO: This can be eliminated --- here only for backward
1371 compatibility */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001372 case 't': { /* 8-bit character buffer, read-only access */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001373 char **p = va_arg(*p_va, char **);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001374 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Christian Heimes4e30a842007-11-30 22:12:06 +00001375 Py_ssize_t count;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001376 Py_buffer view;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001377
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001378 if (*format++ != '#')
1379 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001380 "invalid use of 't' format character",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001381 arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001382 if (pb == NULL || pb->bf_getbuffer == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001383 return converterr(
Alexandre Vassalotti70a23712007-10-14 02:05:51 +00001384 "bytes or read-only character buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001385 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001386
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001387 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001388 return converterr("string or single-segment read-only buffer",
1389 arg, msgbuf, bufsize);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001390
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001391 count = view.len;
1392 *p = view.buf;
Martin v. Löwis423be952008-08-13 15:53:07 +00001393 if (pb->bf_releasebuffer)
1394 return converterr(
1395 "string or pinned buffer",
1396 arg, msgbuf, bufsize);
1397
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001398 PyBuffer_Release(&view);
1399
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001400 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001401 return converterr("(unspecified)", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001402 {
1403 FETCH_SIZE;
1404 STORE_SIZE(count);
1405 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001406 break;
1407 }
1408
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001409 default:
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001410 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001411
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001412 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001413
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001414 *p_format = format;
1415 return NULL;
1416}
Guido van Rossumaa354651996-08-19 19:32:04 +00001417
Martin v. Löwis18e16552006-02-15 17:27:45 +00001418static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001419convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001420{
1421 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001422 Py_ssize_t count;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001423 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001424
1425 *errmsg = NULL;
1426 *p = NULL;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001427 if (pb == NULL ||
Martin v. Löwis423be952008-08-13 15:53:07 +00001428 pb->bf_getbuffer == NULL ||
1429 pb->bf_releasebuffer != NULL) {
Guido van Rossumb0834002007-11-21 21:53:51 +00001430 *errmsg = "bytes or read-only buffer";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001431 return -1;
1432 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001433
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001434 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0) {
Guido van Rossumb0834002007-11-21 21:53:51 +00001435 *errmsg = "bytes or single-segment read-only buffer";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001436 return -1;
1437 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001438 count = view.len;
1439 *p = view.buf;
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001440 PyBuffer_Release(&view);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001441 return count;
1442}
Guido van Rossumaa354651996-08-19 19:32:04 +00001443
Martin v. Löwis423be952008-08-13 15:53:07 +00001444/* XXX for 3.x, getbuffer and convertbuffer can probably
1445 be merged again. */
1446static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001447getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001448{
1449 void *buf;
1450 Py_ssize_t count;
1451 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1452 if (pb == NULL) {
Benjamin Peterson81d90a22008-12-27 02:58:34 +00001453 *errmsg = "bytes or buffer";
Martin v. Löwis423be952008-08-13 15:53:07 +00001454 return -1;
1455 }
1456 if (pb->bf_getbuffer) {
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001457 if (PyObject_GetBuffer(arg, view, 0) < 0) {
Neal Norwitz2f99b242008-08-24 05:48:10 +00001458 *errmsg = "convertible to a buffer";
Martin v. Löwis423be952008-08-13 15:53:07 +00001459 return -1;
Neal Norwitz2f99b242008-08-24 05:48:10 +00001460 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001461 if (!PyBuffer_IsContiguous(view, 'C')) {
1462 *errmsg = "contiguous buffer";
1463 return -1;
1464 }
1465 return 0;
1466 }
1467
1468 count = convertbuffer(arg, &buf, errmsg);
Neal Norwitz2f99b242008-08-24 05:48:10 +00001469 if (count < 0) {
1470 *errmsg = "convertible to a buffer";
Martin v. Löwis423be952008-08-13 15:53:07 +00001471 return count;
Neal Norwitz2f99b242008-08-24 05:48:10 +00001472 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001473 PyBuffer_FillInfo(view, NULL, buf, count, 1, 0);
1474 return 0;
1475}
1476
Guido van Rossumaa354651996-08-19 19:32:04 +00001477/* Support for keyword arguments donated by
1478 Geoff Philbrick <philbric@delphi.hks.com> */
1479
Tim Petersf8cd3e82001-10-27 04:26:57 +00001480/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001481int
1482PyArg_ParseTupleAndKeywords(PyObject *args,
1483 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001484 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001485 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001486{
1487 int retval;
1488 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001489
1490 if ((args == NULL || !PyTuple_Check(args)) ||
1491 (keywords != NULL && !PyDict_Check(keywords)) ||
1492 format == NULL ||
1493 kwlist == NULL)
1494 {
1495 PyErr_BadInternalCall();
Tim Petersf8cd3e82001-10-27 04:26:57 +00001496 return 0;
Tim Peters45772cd2001-10-27 03:58:40 +00001497 }
1498
Guido van Rossumaa354651996-08-19 19:32:04 +00001499 va_start(va, kwlist);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001500 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001501 va_end(va);
1502 return retval;
1503}
1504
1505int
1506_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1507 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001508 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001509 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001510{
1511 int retval;
1512 va_list va;
1513
1514 if ((args == NULL || !PyTuple_Check(args)) ||
1515 (keywords != NULL && !PyDict_Check(keywords)) ||
1516 format == NULL ||
1517 kwlist == NULL)
1518 {
1519 PyErr_BadInternalCall();
1520 return 0;
1521 }
1522
1523 va_start(va, kwlist);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001524 retval = vgetargskeywords(args, keywords, format,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001525 kwlist, &va, FLAG_SIZE_T);
Guido van Rossumaa354651996-08-19 19:32:04 +00001526 va_end(va);
1527 return retval;
1528}
1529
1530
Brett Cannon711e7d92004-07-10 22:20:32 +00001531int
1532PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001533 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001534 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001535 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001536{
1537 int retval;
1538 va_list lva;
1539
1540 if ((args == NULL || !PyTuple_Check(args)) ||
1541 (keywords != NULL && !PyDict_Check(keywords)) ||
1542 format == NULL ||
1543 kwlist == NULL)
1544 {
1545 PyErr_BadInternalCall();
1546 return 0;
1547 }
1548
1549#ifdef VA_LIST_IS_ARRAY
1550 memcpy(lva, va, sizeof(va_list));
1551#else
1552#ifdef __va_copy
1553 __va_copy(lva, va);
1554#else
1555 lva = va;
1556#endif
1557#endif
1558
Guido van Rossum98297ee2007-11-06 21:34:58 +00001559 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001560 return retval;
1561}
1562
1563int
1564_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1565 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001566 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001567 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001568{
1569 int retval;
1570 va_list lva;
1571
1572 if ((args == NULL || !PyTuple_Check(args)) ||
1573 (keywords != NULL && !PyDict_Check(keywords)) ||
1574 format == NULL ||
1575 kwlist == NULL)
1576 {
1577 PyErr_BadInternalCall();
1578 return 0;
1579 }
1580
1581#ifdef VA_LIST_IS_ARRAY
1582 memcpy(lva, va, sizeof(va_list));
1583#else
1584#ifdef __va_copy
1585 __va_copy(lva, va);
1586#else
1587 lva = va;
1588#endif
1589#endif
1590
Guido van Rossum98297ee2007-11-06 21:34:58 +00001591 retval = vgetargskeywords(args, keywords, format,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001592 kwlist, &lva, FLAG_SIZE_T);
Brett Cannon711e7d92004-07-10 22:20:32 +00001593 return retval;
1594}
1595
Christian Heimes380f7f22008-02-28 11:19:05 +00001596#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001597
Guido van Rossumaa354651996-08-19 19:32:04 +00001598static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001599vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001600 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001601{
Tim Petersdc5eff92001-10-27 06:53:00 +00001602 char msgbuf[512];
Guido van Rossumaa354651996-08-19 19:32:04 +00001603 int levels[32];
Christian Heimes380f7f22008-02-28 11:19:05 +00001604 const char *fname, *msg, *custom_msg, *keyword;
1605 int min = INT_MAX;
Tim Petersb639d492001-10-27 07:00:56 +00001606 int i, len, nargs, nkeywords;
Christian Heimes380f7f22008-02-28 11:19:05 +00001607 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001608
Tim Peters45772cd2001-10-27 03:58:40 +00001609 assert(args != NULL && PyTuple_Check(args));
1610 assert(keywords == NULL || PyDict_Check(keywords));
1611 assert(format != NULL);
1612 assert(kwlist != NULL);
1613 assert(p_va != NULL);
1614
Christian Heimes380f7f22008-02-28 11:19:05 +00001615 /* grab the function name or custom error msg first (mutually exclusive) */
1616 fname = strchr(format, ':');
1617 if (fname) {
1618 fname++;
1619 custom_msg = NULL;
Tim Peters62d48e12001-10-27 06:42:16 +00001620 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001621 else {
1622 custom_msg = strchr(format,';');
1623 if (custom_msg)
1624 custom_msg++;
Tim Peters62d48e12001-10-27 06:42:16 +00001625 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001626
1627 /* scan kwlist and get greatest possible nbr of args */
1628 for (len=0; kwlist[len]; len++)
1629 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001630
Tim Peters6fb26352001-10-27 04:38:11 +00001631 nargs = PyTuple_GET_SIZE(args);
Christian Heimes380f7f22008-02-28 11:19:05 +00001632 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1633 if (nargs + nkeywords > len) {
1634 PyErr_Format(PyExc_TypeError, "%s%s takes at most %d "
1635 "argument%s (%d given)",
1636 (fname == NULL) ? "function" : fname,
1637 (fname == NULL) ? "" : "()",
1638 len,
1639 (len == 1) ? "" : "s",
1640 nargs + nkeywords);
Guido van Rossumaa354651996-08-19 19:32:04 +00001641 return 0;
1642 }
Tim Petersc2f01122001-10-27 07:25:06 +00001643
Christian Heimes380f7f22008-02-28 11:19:05 +00001644 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1645 for (i = 0; i < len; i++) {
1646 keyword = kwlist[i];
1647 if (*format == '|') {
1648 min = i;
Guido van Rossumaa354651996-08-19 19:32:04 +00001649 format++;
Christian Heimes380f7f22008-02-28 11:19:05 +00001650 }
1651 if (IS_END_OF_FORMAT(*format)) {
1652 PyErr_Format(PyExc_RuntimeError,
1653 "More keyword list entries (%d) than "
1654 "format specifiers (%d)", len, i);
1655 return cleanreturn(0, freelist);
1656 }
1657 current_arg = NULL;
1658 if (nkeywords) {
1659 current_arg = PyDict_GetItemString(keywords, keyword);
1660 }
1661 if (current_arg) {
1662 --nkeywords;
1663 if (i < nargs) {
1664 /* arg present in tuple and in dict */
1665 PyErr_Format(PyExc_TypeError,
1666 "Argument given by name ('%s') "
1667 "and position (%d)",
1668 keyword, i+1);
1669 return cleanreturn(0, freelist);
1670 }
1671 }
1672 else if (nkeywords && PyErr_Occurred())
1673 return cleanreturn(0, freelist);
1674 else if (i < nargs)
1675 current_arg = PyTuple_GET_ITEM(args, i);
1676
1677 if (current_arg) {
1678 msg = convertitem(current_arg, &format, p_va, flags,
1679 levels, msgbuf, sizeof(msgbuf), &freelist);
1680 if (msg) {
1681 seterror(i+1, msg, levels, fname, custom_msg);
1682 return cleanreturn(0, freelist);
1683 }
1684 continue;
1685 }
1686
1687 if (i < min) {
1688 PyErr_Format(PyExc_TypeError, "Required argument "
1689 "'%s' (pos %d) not found",
1690 keyword, i+1);
1691 return cleanreturn(0, freelist);
1692 }
1693 /* current code reports success when all required args
1694 * fulfilled and no keyword args left, with no further
1695 * validation. XXX Maybe skip this in debug build ?
1696 */
1697 if (!nkeywords)
1698 return cleanreturn(1, freelist);
1699
1700 /* We are into optional args, skip thru to any remaining
1701 * keyword args */
1702 msg = skipitem(&format, p_va, flags);
Guido van Rossumaa354651996-08-19 19:32:04 +00001703 if (msg) {
Christian Heimes380f7f22008-02-28 11:19:05 +00001704 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1705 format);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001706 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001707 }
1708 }
1709
Benjamin Peterson92035012008-12-27 16:00:54 +00001710 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
Christian Heimes380f7f22008-02-28 11:19:05 +00001711 PyErr_Format(PyExc_RuntimeError,
1712 "more argument specifiers than keyword list entries "
1713 "(remaining format:'%s')", format);
1714 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001715 }
Tim Petersb054be42001-10-27 05:07:41 +00001716
Guido van Rossumaa354651996-08-19 19:32:04 +00001717 /* make sure there are no extraneous keyword arguments */
Tim Petersc2f01122001-10-27 07:25:06 +00001718 if (nkeywords > 0) {
1719 PyObject *key, *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001720 Py_ssize_t pos = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001721 while (PyDict_Next(keywords, &pos, &key, &value)) {
Tim Petersc2f01122001-10-27 07:25:06 +00001722 int match = 0;
Guido van Rossum55474762002-04-04 16:22:30 +00001723 char *ks;
Georg Brandld8b690f2008-05-16 17:28:50 +00001724 if (!PyUnicode_Check(key)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00001725 PyErr_SetString(PyExc_TypeError,
Guido van Rossum55474762002-04-04 16:22:30 +00001726 "keywords must be strings");
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001727 return cleanreturn(0, freelist);
Guido van Rossum55474762002-04-04 16:22:30 +00001728 }
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001729 ks = _PyUnicode_AsString(key);
Christian Heimes380f7f22008-02-28 11:19:05 +00001730 for (i = 0; i < len; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001731 if (!strcmp(ks, kwlist[i])) {
1732 match = 1;
1733 break;
1734 }
1735 }
1736 if (!match) {
Tim Petersc2f01122001-10-27 07:25:06 +00001737 PyErr_Format(PyExc_TypeError,
1738 "'%s' is an invalid keyword "
1739 "argument for this function",
1740 ks);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001741 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001742 }
1743 }
1744 }
Tim Petersc2f01122001-10-27 07:25:06 +00001745
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001746 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001747}
1748
1749
1750static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001751skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001752{
Christian Heimes380f7f22008-02-28 11:19:05 +00001753 const char *format = *p_format;
Guido van Rossumaa354651996-08-19 19:32:04 +00001754 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001755
Guido van Rossumaa354651996-08-19 19:32:04 +00001756 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001757
1758 /* simple codes
1759 * The individual types (second arg of va_arg) are irrelevant */
1760
Guido van Rossumaa354651996-08-19 19:32:04 +00001761 case 'b': /* byte -- very short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001762 case 'B': /* byte as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001763 case 'h': /* short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001764 case 'H': /* short int as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001765 case 'i': /* int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001766 case 'I': /* int sized bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001767 case 'l': /* long int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001768 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001769#ifdef HAVE_LONG_LONG
Georg Brandl6dd14612005-09-14 19:29:53 +00001770 case 'L': /* PY_LONG_LONG */
1771 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001772#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001773 case 'f': /* float */
Guido van Rossumaa354651996-08-19 19:32:04 +00001774 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001775#ifndef WITHOUT_COMPLEX
1776 case 'D': /* complex double */
Georg Brandl6dd14612005-09-14 19:29:53 +00001777#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001778 case 'c': /* char */
1779 {
Georg Brandl6dd14612005-09-14 19:29:53 +00001780 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001781 break;
1782 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001783
1784 case 'n': /* Py_ssize_t */
1785 {
1786 (void) va_arg(*p_va, Py_ssize_t *);
1787 break;
1788 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001789
Georg Brandl6dd14612005-09-14 19:29:53 +00001790 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001791
Georg Brandl6dd14612005-09-14 19:29:53 +00001792 case 'e': /* string with encoding */
1793 {
1794 (void) va_arg(*p_va, const char *);
1795 if (!(*format == 's' || *format == 't'))
1796 /* after 'e', only 's' and 't' is allowed */
1797 goto err;
1798 format++;
1799 /* explicit fallthrough to string cases */
1800 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001801
Guido van Rossumaa354651996-08-19 19:32:04 +00001802 case 's': /* string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001803 case 'z': /* string or None */
Walter Dörwald612344f2007-05-04 19:28:21 +00001804 case 'y': /* bytes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001805 case 'u': /* unicode string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001806 case 't': /* buffer, read-only */
1807 case 'w': /* buffer, read-write */
Guido van Rossumaa354651996-08-19 19:32:04 +00001808 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001809 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001810 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001811 if (flags & FLAG_SIZE_T)
1812 (void) va_arg(*p_va, Py_ssize_t *);
1813 else
1814 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001815 format++;
Martin v. Löwis423be952008-08-13 15:53:07 +00001816 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1817 format++;
Guido van Rossumaa354651996-08-19 19:32:04 +00001818 }
1819 break;
1820 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001821
1822 /* object codes */
1823
Guido van Rossumaa354651996-08-19 19:32:04 +00001824 case 'S': /* string object */
Guido van Rossum617dbc42007-05-07 23:57:08 +00001825 case 'Y': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001826 case 'U': /* unicode string object */
Guido van Rossumaa354651996-08-19 19:32:04 +00001827 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001828 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001829 break;
1830 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001831
Guido van Rossumaa354651996-08-19 19:32:04 +00001832 case 'O': /* object */
1833 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001834 if (*format == '!') {
1835 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001836 (void) va_arg(*p_va, PyTypeObject*);
1837 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001838 }
1839#if 0
1840/* I don't know what this is for */
1841 else if (*format == '?') {
1842 inquiry pred = va_arg(*p_va, inquiry);
1843 format++;
1844 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001845 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001846 }
1847 }
1848#endif
1849 else if (*format == '&') {
Tim Petersdbd9ba62000-07-09 03:09:57 +00001850 typedef int (*converter)(PyObject *, void *);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001851 (void) va_arg(*p_va, converter);
1852 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001853 format++;
1854 }
1855 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001856 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001857 }
1858 break;
1859 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001860
Christian Heimes380f7f22008-02-28 11:19:05 +00001861 case '(': /* bypass tuple, not handled at all previously */
1862 {
1863 char *msg;
1864 for (;;) {
1865 if (*format==')')
1866 break;
1867 if (IS_END_OF_FORMAT(*format))
1868 return "Unmatched left paren in format "
1869 "string";
1870 msg = skipitem(&format, p_va, flags);
1871 if (msg)
1872 return msg;
1873 }
1874 format++;
1875 break;
1876 }
1877
1878 case ')':
1879 return "Unmatched right paren in format string";
1880
Guido van Rossumaa354651996-08-19 19:32:04 +00001881 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001882err:
Guido van Rossumaa354651996-08-19 19:32:04 +00001883 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001884
Guido van Rossumaa354651996-08-19 19:32:04 +00001885 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001886
Guido van Rossumaa354651996-08-19 19:32:04 +00001887 *p_format = format;
1888 return NULL;
1889}
Fred Drakee4616e62001-10-23 21:09:29 +00001890
1891
1892int
Martin v. Löwis76246742006-03-01 04:06:10 +00001893PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001894{
Martin v. Löwis76246742006-03-01 04:06:10 +00001895 Py_ssize_t i, l;
Fred Drakee4616e62001-10-23 21:09:29 +00001896 PyObject **o;
1897 va_list vargs;
1898
1899#ifdef HAVE_STDARG_PROTOTYPES
1900 va_start(vargs, max);
1901#else
1902 va_start(vargs);
1903#endif
1904
1905 assert(min >= 0);
1906 assert(min <= max);
1907 if (!PyTuple_Check(args)) {
1908 PyErr_SetString(PyExc_SystemError,
1909 "PyArg_UnpackTuple() argument list is not a tuple");
1910 return 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001911 }
Fred Drakee4616e62001-10-23 21:09:29 +00001912 l = PyTuple_GET_SIZE(args);
1913 if (l < min) {
1914 if (name != NULL)
1915 PyErr_Format(
1916 PyExc_TypeError,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001917 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001918 name, (min == max ? "" : "at least "), min, l);
1919 else
1920 PyErr_Format(
1921 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001922 "unpacked tuple should have %s%zd elements,"
Guido van Rossum98297ee2007-11-06 21:34:58 +00001923 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001924 (min == max ? "" : "at least "), min, l);
1925 va_end(vargs);
1926 return 0;
1927 }
1928 if (l > max) {
1929 if (name != NULL)
1930 PyErr_Format(
1931 PyExc_TypeError,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001932 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001933 name, (min == max ? "" : "at most "), max, l);
1934 else
1935 PyErr_Format(
1936 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001937 "unpacked tuple should have %s%zd elements,"
Guido van Rossum98297ee2007-11-06 21:34:58 +00001938 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001939 (min == max ? "" : "at most "), max, l);
1940 va_end(vargs);
1941 return 0;
1942 }
1943 for (i = 0; i < l; i++) {
1944 o = va_arg(vargs, PyObject **);
1945 *o = PyTuple_GET_ITEM(args, i);
1946 }
1947 va_end(vargs);
1948 return 1;
1949}
Georg Brandl02c42872005-08-26 06:42:30 +00001950
1951
1952/* For type constructors that don't take keyword args
1953 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001954 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001955 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001956 */
1957int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001958_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001959{
1960 if (kw == NULL)
1961 return 1;
1962 if (!PyDict_CheckExact(kw)) {
1963 PyErr_BadInternalCall();
1964 return 0;
1965 }
1966 if (PyDict_Size(kw) == 0)
1967 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001968
1969 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
Georg Brandl02c42872005-08-26 06:42:30 +00001970 funcname);
1971 return 0;
1972}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001973#ifdef __cplusplus
1974};
1975#endif