blob: 37f1898819a37bd5449ff06b25bba18c3d608a46 [file] [log] [blame]
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001
2/* New getargs implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00005
Guido van Rossumc1d50531996-08-21 23:38:24 +00006#include <ctype.h>
7
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00008
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00009#ifdef __cplusplus
Guido van Rossum98297ee2007-11-06 21:34:58 +000010extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000011#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000012int PyArg_Parse(PyObject *, const char *, ...);
13int PyArg_ParseTuple(PyObject *, const char *, ...);
14int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000015
Tim Petersdbd9ba62000-07-09 03:09:57 +000016int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000017 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000018int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000019 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000020
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000021#ifdef HAVE_DECLSPEC_DLL
22/* Export functions */
23PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, char *, ...);
24PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, char *, ...);
25PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
26 const char *, char **, ...);
27PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
28PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, char *, va_list);
29PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
30 const char *, char **, va_list);
31#endif
32
Martin v. Löwis18e16552006-02-15 17:27:45 +000033#define FLAG_COMPAT 1
34#define FLAG_SIZE_T 2
35
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040036typedef int (*destr_t)(PyObject *, void *);
37
38
39/* Keep track of "objects" that have been allocated or initialized and
40 which will need to be deallocated or cleaned up somehow if overall
41 parsing fails.
42*/
43typedef struct {
44 void *item;
45 destr_t destructor;
46} freelistentry_t;
47
48typedef struct {
49 int first_available;
50 freelistentry_t *entries;
51} freelist_t;
52
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000053
54/* Forward */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000055static int vgetargs1(PyObject *, const char *, va_list *, int);
56static void seterror(int, const char *, int *, const char *, const char *);
Guido van Rossum98297ee2007-11-06 21:34:58 +000057static char *convertitem(PyObject *, const char **, va_list *, int, int *,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040058 char *, size_t, freelist_t *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000059static char *converttuple(PyObject *, const char **, va_list *, int,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040060 int *, char *, size_t, int, freelist_t *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000061static char *convertsimple(PyObject *, const char **, va_list *, int, char *,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040062 size_t, freelist_t *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000063static Py_ssize_t convertbuffer(PyObject *, void **p, char **);
Martin v. Löwis423be952008-08-13 15:53:07 +000064static int getbuffer(PyObject *, Py_buffer *, char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000065
Tim Petersdbd9ba62000-07-09 03:09:57 +000066static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000067 const char *, char **, va_list *, int);
Martin v. Löwis18e16552006-02-15 17:27:45 +000068static char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000069
Fred Drake563dfc22001-10-23 14:41:08 +000070int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000071PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000072{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000073 int retval;
74 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000075
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000076 va_start(va, format);
77 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
78 va_end(va);
79 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +000080}
81
82int
83_PyArg_Parse_SizeT(PyObject *args, char *format, ...)
84{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000085 int retval;
86 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000087
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000088 va_start(va, format);
89 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
90 va_end(va);
91 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000092}
93
94
Fred Drake563dfc22001-10-23 14:41:08 +000095int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000096PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000097{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000098 int retval;
99 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000101 va_start(va, format);
102 retval = vgetargs1(args, format, &va, 0);
103 va_end(va);
104 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000105}
106
Martin v. Löwis18e16552006-02-15 17:27:45 +0000107int
108_PyArg_ParseTuple_SizeT(PyObject *args, char *format, ...)
109{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000110 int retval;
111 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000112
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000113 va_start(va, format);
114 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
115 va_end(va);
116 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000117}
118
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000119
120int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000121PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000122{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000123 va_list lva;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000124
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000125 Py_VA_COPY(lva, va);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000127 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000128}
129
Martin v. Löwis18e16552006-02-15 17:27:45 +0000130int
131_PyArg_VaParse_SizeT(PyObject *args, char *format, va_list va)
132{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000133 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000134
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000135 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000136
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000138}
139
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000140
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000141/* Handle cleanup of allocated memory in case of exception */
142
Benjamin Petersonb173f782009-05-05 22:31:58 +0000143#define GETARGS_CAPSULE_NAME_CLEANUP_PTR "getargs.cleanup_ptr"
144#define GETARGS_CAPSULE_NAME_CLEANUP_BUFFER "getargs.cleanup_buffer"
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000145#define GETARGS_CAPSULE_NAME_CLEANUP_CONVERT "getargs.cleanup_convert"
Benjamin Petersonb173f782009-05-05 22:31:58 +0000146
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400147static int
148cleanup_ptr(PyObject *self, void *ptr)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000149{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000150 if (ptr) {
151 PyMem_FREE(ptr);
152 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000153 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000154}
155
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000156static int
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400157cleanup_buffer(PyObject *self, void *ptr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000158{
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400159 Py_buffer *buf = (Py_buffer *)ptr;
160 if (buf) {
161 PyBuffer_Release(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000162 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400163 return 0;
164}
165
166static int
167addcleanup(void *ptr, freelist_t *freelist, destr_t destructor)
168{
169 int index;
170
171 index = freelist->first_available;
172 freelist->first_available += 1;
173
174 freelist->entries[index].item = ptr;
175 freelist->entries[index].destructor = destructor;
176
177 return 0;
178}
179
180static int
181cleanreturn(int retval, freelist_t *freelist)
182{
183 int index;
184
185 if (retval == 0) {
186 /* A failure occurred, therefore execute all of the cleanup
187 functions.
188 */
189 for (index = 0; index < freelist->first_available; ++index) {
190 freelist->entries[index].destructor(NULL,
191 freelist->entries[index].item);
192 }
193 }
194 PyMem_Free(freelist->entries);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000195 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000196}
197
198
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000199static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000200vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000201{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000202 char msgbuf[256];
203 int levels[32];
204 const char *fname = NULL;
205 const char *message = NULL;
206 int min = -1;
207 int max = 0;
208 int level = 0;
209 int endfmt = 0;
210 const char *formatsave = format;
211 Py_ssize_t i, len;
212 char *msg;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400213 freelist_t freelist = {0, NULL};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000214 int compat = flags & FLAG_COMPAT;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000215
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000216 assert(compat || (args != (PyObject*)NULL));
217 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000218
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000219 while (endfmt == 0) {
220 int c = *format++;
221 switch (c) {
222 case '(':
223 if (level == 0)
224 max++;
225 level++;
226 if (level >= 30)
227 Py_FatalError("too many tuple nesting levels "
228 "in argument format string");
229 break;
230 case ')':
231 if (level == 0)
232 Py_FatalError("excess ')' in getargs format");
233 else
234 level--;
235 break;
236 case '\0':
237 endfmt = 1;
238 break;
239 case ':':
240 fname = format;
241 endfmt = 1;
242 break;
243 case ';':
244 message = format;
245 endfmt = 1;
246 break;
247 default:
248 if (level == 0) {
249 if (c == 'O')
250 max++;
251 else if (isalpha(Py_CHARMASK(c))) {
252 if (c != 'e') /* skip encoded */
253 max++;
254 } else if (c == '|')
255 min = max;
256 }
257 break;
258 }
259 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000260
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000261 if (level != 0)
262 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000263
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000264 if (min < 0)
265 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000267 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000268
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400269 freelist.entries = PyMem_New(freelistentry_t, max);
270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000271 if (compat) {
272 if (max == 0) {
273 if (args == NULL)
274 return 1;
Victor Stinner6ced7c42011-03-21 18:15:42 +0100275 PyErr_Format(PyExc_TypeError,
276 "%.200s%s takes no arguments",
277 fname==NULL ? "function" : fname,
278 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400279 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000280 }
281 else if (min == 1 && max == 1) {
282 if (args == NULL) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100283 PyErr_Format(PyExc_TypeError,
284 "%.200s%s takes at least one argument",
285 fname==NULL ? "function" : fname,
286 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400287 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000288 }
289 msg = convertitem(args, &format, p_va, flags, levels,
290 msgbuf, sizeof(msgbuf), &freelist);
291 if (msg == NULL)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400292 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000293 seterror(levels[0], msg, levels+1, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400294 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000295 }
296 else {
297 PyErr_SetString(PyExc_SystemError,
298 "old style getargs format uses new features");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400299 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000300 }
301 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000302
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000303 if (!PyTuple_Check(args)) {
304 PyErr_SetString(PyExc_SystemError,
305 "new style getargs format but argument is not a tuple");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400306 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000309 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000310
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000311 if (len < min || max < len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100312 if (message == NULL)
313 PyErr_Format(PyExc_TypeError,
314 "%.150s%s takes %s %d argument%s (%ld given)",
315 fname==NULL ? "function" : fname,
316 fname==NULL ? "" : "()",
317 min==max ? "exactly"
318 : len < min ? "at least" : "at most",
319 len < min ? min : max,
320 (len < min ? min : max) == 1 ? "" : "s",
321 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
322 else
323 PyErr_SetString(PyExc_TypeError, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400324 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000325 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000326
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000327 for (i = 0; i < len; i++) {
328 if (*format == '|')
329 format++;
330 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
331 flags, levels, msgbuf,
332 sizeof(msgbuf), &freelist);
333 if (msg) {
334 seterror(i+1, msg, levels, fname, msg);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400335 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000336 }
337 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000338
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
340 *format != '(' &&
341 *format != '|' && *format != ':' && *format != ';') {
342 PyErr_Format(PyExc_SystemError,
343 "bad format string: %.200s", formatsave);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400344 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000345 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000346
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400347 return cleanreturn(1, &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000348}
349
350
351
352static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000353seterror(int iarg, const char *msg, int *levels, const char *fname,
354 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000355{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000356 char buf[512];
357 int i;
358 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000360 if (PyErr_Occurred())
361 return;
362 else if (message == NULL) {
363 if (fname != NULL) {
364 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
365 p += strlen(p);
366 }
367 if (iarg != 0) {
368 PyOS_snprintf(p, sizeof(buf) - (p - buf),
369 "argument %d", iarg);
370 i = 0;
371 p += strlen(p);
372 while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
373 PyOS_snprintf(p, sizeof(buf) - (p - buf),
374 ", item %d", levels[i]-1);
375 p += strlen(p);
376 i++;
377 }
378 }
379 else {
380 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
381 p += strlen(p);
382 }
383 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
384 message = buf;
385 }
386 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000387}
388
389
390/* Convert a tuple argument.
391 On entry, *p_format points to the character _after_ the opening '('.
392 On successful exit, *p_format points to the closing ')'.
393 If successful:
394 *p_format and *p_va are updated,
395 *levels and *msgbuf are untouched,
396 and NULL is returned.
397 If the argument is invalid:
398 *p_format is unchanged,
399 *p_va is undefined,
400 *levels is a 0-terminated list of item numbers,
401 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000402 "must be <typename1>, not <typename2>", where:
403 <typename1> is the name of the expected type, and
404 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000405 and msgbuf is returned.
406*/
407
408static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000409converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000410 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400411 freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000412{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000413 int level = 0;
414 int n = 0;
415 const char *format = *p_format;
416 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000417
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000418 for (;;) {
419 int c = *format++;
420 if (c == '(') {
421 if (level == 0)
422 n++;
423 level++;
424 }
425 else if (c == ')') {
426 if (level == 0)
427 break;
428 level--;
429 }
430 else if (c == ':' || c == ';' || c == '\0')
431 break;
432 else if (level == 0 && isalpha(Py_CHARMASK(c)))
433 n++;
434 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000436 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
437 levels[0] = 0;
438 PyOS_snprintf(msgbuf, bufsize,
439 toplevel ? "expected %d arguments, not %.50s" :
440 "must be %d-item sequence, not %.50s",
441 n,
442 arg == Py_None ? "None" : arg->ob_type->tp_name);
443 return msgbuf;
444 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000446 if ((i = PySequence_Size(arg)) != n) {
447 levels[0] = 0;
448 PyOS_snprintf(msgbuf, bufsize,
449 toplevel ? "expected %d arguments, not %d" :
450 "must be sequence of length %d, not %d",
451 n, i);
452 return msgbuf;
453 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000454
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000455 format = *p_format;
456 for (i = 0; i < n; i++) {
457 char *msg;
458 PyObject *item;
459 item = PySequence_GetItem(arg, i);
460 if (item == NULL) {
461 PyErr_Clear();
462 levels[0] = i+1;
463 levels[1] = 0;
464 strncpy(msgbuf, "is not retrievable", bufsize);
465 return msgbuf;
466 }
467 msg = convertitem(item, &format, p_va, flags, levels+1,
468 msgbuf, bufsize, freelist);
469 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
470 Py_XDECREF(item);
471 if (msg != NULL) {
472 levels[0] = i+1;
473 return msg;
474 }
475 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000476
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000477 *p_format = format;
478 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000479}
480
481
482/* Convert a single item. */
483
484static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000485convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400486 int *levels, char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000487{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000488 char *msg;
489 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000491 if (*format == '(' /* ')' */) {
492 format++;
493 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
494 bufsize, 0, freelist);
495 if (msg == NULL)
496 format++;
497 }
498 else {
499 msg = convertsimple(arg, &format, p_va, flags,
500 msgbuf, bufsize, freelist);
501 if (msg != NULL)
502 levels[0] = 0;
503 }
504 if (msg == NULL)
505 *p_format = format;
506 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000507}
508
509
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000510
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000511/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000512
513static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000514converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000515{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 assert(expected != NULL);
517 assert(arg != NULL);
518 PyOS_snprintf(msgbuf, bufsize,
519 "must be %.50s, not %.50s", expected,
520 arg == Py_None ? "None" : arg->ob_type->tp_name);
521 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000522}
523
524#define CONV_UNICODE "(unicode conversion error)"
525
Guido van Rossum45aecf42006-03-15 04:58:47 +0000526/* Explicitly check for float arguments when integers are expected.
527 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000528static int
529float_argument_error(PyObject *arg)
530{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000531 if (PyFloat_Check(arg)) {
532 PyErr_SetString(PyExc_TypeError,
533 "integer argument expected, got float" );
534 return 1;
535 }
536 else
537 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000538}
539
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000540/* Convert a non-tuple argument. Return NULL if conversion went OK,
541 or a string with a message describing the failure. The message is
542 formatted as "must be <desired type>, not <actual type>".
543 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000544 Don't call if a tuple is expected.
545
546 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000547*/
548
549static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000550convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400551 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000552{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000553 /* For # codes */
554#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
555 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
556 else q=va_arg(*p_va, int*);
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000557#define STORE_SIZE(s) \
558 if (flags & FLAG_SIZE_T) \
559 *q2=s; \
560 else { \
561 if (INT_MAX < s) { \
562 PyErr_SetString(PyExc_OverflowError, \
563 "size does not fit in an int"); \
564 return converterr("", arg, msgbuf, bufsize); \
565 } \
566 *q=s; \
567 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000568#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000569#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000570
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000571 const char *format = *p_format;
572 char c = *format++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200573 char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000574
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000575 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000576
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000577 case 'b': { /* unsigned byte -- very short int */
578 char *p = va_arg(*p_va, char *);
579 long ival;
580 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000581 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000582 ival = PyLong_AsLong(arg);
583 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000584 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000585 else if (ival < 0) {
586 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000587 "unsigned byte integer is less than minimum");
588 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000589 }
590 else if (ival > UCHAR_MAX) {
591 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000592 "unsigned byte integer is greater than maximum");
593 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000594 }
595 else
596 *p = (unsigned char) ival;
597 break;
598 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000599
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000600 case 'B': {/* byte sized bitfield - both signed and unsigned
601 values allowed */
602 char *p = va_arg(*p_va, char *);
603 long ival;
604 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000605 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000606 ival = PyLong_AsUnsignedLongMask(arg);
607 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000608 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000609 else
610 *p = (unsigned char) ival;
611 break;
612 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000613
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000614 case 'h': {/* signed short int */
615 short *p = va_arg(*p_va, short *);
616 long ival;
617 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000618 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 ival = PyLong_AsLong(arg);
620 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000621 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000622 else if (ival < SHRT_MIN) {
623 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000624 "signed short integer is less than minimum");
625 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000626 }
627 else if (ival > SHRT_MAX) {
628 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000629 "signed short integer is greater than maximum");
630 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000631 }
632 else
633 *p = (short) ival;
634 break;
635 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000636
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000637 case 'H': { /* short int sized bitfield, both signed and
638 unsigned allowed */
639 unsigned short *p = va_arg(*p_va, unsigned short *);
640 long ival;
641 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000642 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000643 ival = PyLong_AsUnsignedLongMask(arg);
644 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000645 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000646 else
647 *p = (unsigned short) ival;
648 break;
649 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000650
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000651 case 'i': {/* signed int */
652 int *p = va_arg(*p_va, int *);
653 long ival;
654 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000655 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000656 ival = PyLong_AsLong(arg);
657 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000658 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000659 else if (ival > INT_MAX) {
660 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000661 "signed integer is greater than maximum");
662 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000663 }
664 else if (ival < INT_MIN) {
665 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000666 "signed integer is less than minimum");
667 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000668 }
669 else
670 *p = ival;
671 break;
672 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000674 case 'I': { /* int sized bitfield, both signed and
675 unsigned allowed */
676 unsigned int *p = va_arg(*p_va, unsigned int *);
677 unsigned int ival;
678 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000679 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000680 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
681 if (ival == (unsigned int)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000682 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000683 else
684 *p = ival;
685 break;
686 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000687
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000688 case 'n': /* Py_ssize_t */
689 {
690 PyObject *iobj;
691 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
692 Py_ssize_t ival = -1;
693 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000694 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000695 iobj = PyNumber_Index(arg);
696 if (iobj != NULL) {
697 ival = PyLong_AsSsize_t(iobj);
698 Py_DECREF(iobj);
699 }
700 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000701 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000702 *p = ival;
703 break;
704 }
705 case 'l': {/* long int */
706 long *p = va_arg(*p_va, long *);
707 long ival;
708 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000709 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000710 ival = PyLong_AsLong(arg);
711 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000712 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 else
714 *p = ival;
715 break;
716 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000717
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 case 'k': { /* long sized bitfield */
719 unsigned long *p = va_arg(*p_va, unsigned long *);
720 unsigned long ival;
721 if (PyLong_Check(arg))
722 ival = PyLong_AsUnsignedLongMask(arg);
723 else
724 return converterr("integer<k>", arg, msgbuf, bufsize);
725 *p = ival;
726 break;
727 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000728
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000729#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 case 'L': {/* PY_LONG_LONG */
731 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
732 PY_LONG_LONG ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000733 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000734 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 ival = PyLong_AsLongLong(arg);
Mark Dickinsonc7301312010-06-10 16:05:10 +0000736 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000737 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000738 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 break;
741 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000742
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000743 case 'K': { /* long long sized bitfield */
744 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
745 unsigned PY_LONG_LONG ival;
746 if (PyLong_Check(arg))
747 ival = PyLong_AsUnsignedLongLongMask(arg);
748 else
749 return converterr("integer<K>", arg, msgbuf, bufsize);
750 *p = ival;
751 break;
752 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000753#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 case 'f': {/* float */
756 float *p = va_arg(*p_va, float *);
757 double dval = PyFloat_AsDouble(arg);
758 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000759 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 else
761 *p = (float) dval;
762 break;
763 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000764
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000765 case 'd': {/* double */
766 double *p = va_arg(*p_va, double *);
767 double dval = PyFloat_AsDouble(arg);
768 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000769 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000770 else
771 *p = dval;
772 break;
773 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000774
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000775 case 'D': {/* complex double */
776 Py_complex *p = va_arg(*p_va, Py_complex *);
777 Py_complex cval;
778 cval = PyComplex_AsCComplex(arg);
779 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000780 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 else
782 *p = cval;
783 break;
784 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000785
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000786 case 'c': {/* char */
787 char *p = va_arg(*p_va, char *);
788 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
789 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300790 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
791 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000792 else
793 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
794 break;
795 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000796
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000797 case 'C': {/* unicode char */
798 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200799 int kind;
800 void *data;
801
802 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200804
805 if (PyUnicode_READY(arg))
806 RETURN_ERR_OCCURRED;
807
808 if (PyUnicode_GET_LENGTH(arg) != 1)
809 return converterr("a unicode character", arg, msgbuf, bufsize);
810
811 kind = PyUnicode_KIND(arg);
812 data = PyUnicode_DATA(arg);
813 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000814 break;
815 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000816
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000817 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000818 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000819
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000820 case 'y': {/* any buffer-like object, but not PyUnicode */
821 void **p = (void **)va_arg(*p_va, char **);
822 char *buf;
823 Py_ssize_t count;
824 if (*format == '*') {
825 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
826 return converterr(buf, arg, msgbuf, bufsize);
827 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400828 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000829 return converterr(
830 "(cleanup problem)",
831 arg, msgbuf, bufsize);
832 }
833 break;
834 }
835 count = convertbuffer(arg, p, &buf);
836 if (count < 0)
837 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000838 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000839 FETCH_SIZE;
840 STORE_SIZE(count);
841 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000842 } else {
843 if (strlen(*p) != count)
844 return converterr(
845 "bytes without null bytes",
846 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000847 }
848 break;
849 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000850
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000851 case 's': /* text string */
852 case 'z': /* text string or None */
853 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000854 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000855 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000857
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000858 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
860 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200861 Py_ssize_t len;
862 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
863 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000864 return converterr(CONV_UNICODE,
865 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200866 PyBuffer_FillInfo(p, arg, sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 }
868 else { /* any buffer-like object */
869 char *buf;
870 if (getbuffer(arg, p, &buf) < 0)
871 return converterr(buf, arg, msgbuf, bufsize);
872 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400873 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000874 return converterr(
875 "(cleanup problem)",
876 arg, msgbuf, bufsize);
877 }
878 format++;
879 } else if (*format == '#') { /* any buffer-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000880 /* "s#" or "z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 void **p = (void **)va_arg(*p_va, char **);
882 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000883
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000884 if (c == 'z' && arg == Py_None) {
885 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000886 STORE_SIZE(0);
887 }
888 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200889 Py_ssize_t len;
890 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
891 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000892 return converterr(CONV_UNICODE,
893 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200894 *p = sarg;
895 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000896 }
897 else { /* any buffer-like object */
898 /* XXX Really? */
899 char *buf;
900 Py_ssize_t count = convertbuffer(arg, p, &buf);
901 if (count < 0)
902 return converterr(buf, arg, msgbuf, bufsize);
903 STORE_SIZE(count);
904 }
905 format++;
906 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000907 /* "s" or "z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000908 char **p = va_arg(*p_va, char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200909 Py_ssize_t len;
910 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000911
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000912 if (c == 'z' && arg == Py_None)
913 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000914 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200915 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
916 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000917 return converterr(CONV_UNICODE,
918 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200919 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000920 }
921 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000922 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000923 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200924 if (*p != NULL && sarg != NULL && (Py_ssize_t) strlen(*p) != len)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000925 return converterr(
Victor Stinner9d663d02011-10-13 23:25:03 +0200926 c == 'z' ? "str without null characters or None"
927 : "str without null characters",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000928 arg, msgbuf, bufsize);
929 }
930 break;
931 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000932
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000933 case 'u': /* raw unicode buffer (Py_UNICODE *) */
934 case 'Z': /* raw unicode buffer or None */
935 {
Brett Cannonb94767f2011-02-22 20:15:44 +0000936 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
937
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000938 if (*format == '#') { /* any buffer-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000939 /* "s#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000940 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000941
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000942 if (c == 'Z' && arg == Py_None) {
943 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000944 STORE_SIZE(0);
945 }
946 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200947 Py_ssize_t len;
948 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200949 if (*p == NULL)
950 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200951 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000952 }
Victor Stinner5216e6d2010-06-08 21:45:51 +0000953 else
954 return converterr("str or None", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 format++;
956 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000957 /* "s" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000958 if (c == 'Z' && arg == Py_None)
959 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000960 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200961 Py_ssize_t len;
962 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200963 if (*p == NULL)
964 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200965 if (Py_UNICODE_strlen(*p) != len)
Victor Stinner06e49dd2010-06-13 18:21:50 +0000966 return converterr(
Victor Stinner9d663d02011-10-13 23:25:03 +0200967 "str without null characters or None",
Victor Stinner06e49dd2010-06-13 18:21:50 +0000968 arg, msgbuf, bufsize);
969 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000970 return converterr(c == 'Z' ? "str or None" : "str",
971 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 }
973 break;
974 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 case 'e': {/* encoded string */
977 char **buffer;
978 const char *encoding;
979 PyObject *s;
980 int recode_strings;
981 Py_ssize_t size;
982 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +0000983
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000984 /* Get 'e' parameter: the encoding name */
985 encoding = (const char *)va_arg(*p_va, const char *);
986 if (encoding == NULL)
987 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +0000988
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000989 /* Get output buffer parameter:
990 's' (recode all objects via Unicode) or
991 't' (only recode non-string objects)
992 */
993 if (*format == 's')
994 recode_strings = 1;
995 else if (*format == 't')
996 recode_strings = 0;
997 else
998 return converterr(
999 "(unknown parser marker combination)",
1000 arg, msgbuf, bufsize);
1001 buffer = (char **)va_arg(*p_va, char **);
1002 format++;
1003 if (buffer == NULL)
1004 return converterr("(buffer is NULL)",
1005 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001007 /* Encode object */
1008 if (!recode_strings &&
1009 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1010 s = arg;
1011 Py_INCREF(s);
1012 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1013 return converterr("(AsCharBuffer failed)",
1014 arg, msgbuf, bufsize);
1015 }
1016 else {
1017 PyObject *u;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001018
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001019 /* Convert object to Unicode */
1020 u = PyUnicode_FromObject(arg);
1021 if (u == NULL)
1022 return converterr(
1023 "string or unicode or text buffer",
1024 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001025
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001026 /* Encode object; use default error handling */
1027 s = PyUnicode_AsEncodedString(u,
1028 encoding,
1029 NULL);
1030 Py_DECREF(u);
1031 if (s == NULL)
1032 return converterr("(encoding failed)",
1033 arg, msgbuf, bufsize);
1034 if (!PyBytes_Check(s)) {
1035 Py_DECREF(s);
1036 return converterr(
1037 "(encoder failed to return bytes)",
1038 arg, msgbuf, bufsize);
1039 }
1040 size = PyBytes_GET_SIZE(s);
1041 ptr = PyBytes_AS_STRING(s);
1042 if (ptr == NULL)
1043 ptr = "";
1044 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 /* Write output; output is guaranteed to be 0-terminated */
1047 if (*format == '#') {
1048 /* Using buffer length parameter '#':
1049
1050 - if *buffer is NULL, a new buffer of the
1051 needed size is allocated and the data
1052 copied into it; *buffer is updated to point
1053 to the new buffer; the caller is
1054 responsible for PyMem_Free()ing it after
1055 usage
1056
1057 - if *buffer is not NULL, the data is
1058 copied to *buffer; *buffer_len has to be
1059 set to the size of the buffer on input;
1060 buffer overflow is signalled with an error;
1061 buffer has to provide enough room for the
1062 encoded string plus the trailing 0-byte
1063
1064 - in both cases, *buffer_len is updated to
1065 the size of the buffer /excluding/ the
1066 trailing 0-byte
1067
1068 */
1069 FETCH_SIZE;
1070
1071 format++;
1072 if (q == NULL && q2 == NULL) {
1073 Py_DECREF(s);
1074 return converterr(
1075 "(buffer_len is NULL)",
1076 arg, msgbuf, bufsize);
1077 }
1078 if (*buffer == NULL) {
1079 *buffer = PyMem_NEW(char, size + 1);
1080 if (*buffer == NULL) {
1081 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001082 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001083 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001084 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001085 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 Py_DECREF(s);
1087 return converterr(
1088 "(cleanup problem)",
1089 arg, msgbuf, bufsize);
1090 }
1091 } else {
1092 if (size + 1 > BUFFER_LEN) {
1093 Py_DECREF(s);
1094 return converterr(
1095 "(buffer overflow)",
1096 arg, msgbuf, bufsize);
1097 }
1098 }
1099 memcpy(*buffer, ptr, size+1);
1100 STORE_SIZE(size);
1101 } else {
1102 /* Using a 0-terminated buffer:
1103
1104 - the encoded string has to be 0-terminated
1105 for this variant to work; if it is not, an
1106 error raised
1107
1108 - a new buffer of the needed size is
1109 allocated and the data copied into it;
1110 *buffer is updated to point to the new
1111 buffer; the caller is responsible for
1112 PyMem_Free()ing it after usage
1113
1114 */
1115 if ((Py_ssize_t)strlen(ptr) != size) {
1116 Py_DECREF(s);
1117 return converterr(
1118 "encoded string without NULL bytes",
1119 arg, msgbuf, bufsize);
1120 }
1121 *buffer = PyMem_NEW(char, size + 1);
1122 if (*buffer == NULL) {
1123 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001124 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001125 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001126 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001127 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 Py_DECREF(s);
1129 return converterr("(cleanup problem)",
1130 arg, msgbuf, bufsize);
1131 }
1132 memcpy(*buffer, ptr, size+1);
1133 }
1134 Py_DECREF(s);
1135 break;
1136 }
1137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001138 case 'S': { /* PyBytes object */
1139 PyObject **p = va_arg(*p_va, PyObject **);
1140 if (PyBytes_Check(arg))
1141 *p = arg;
1142 else
1143 return converterr("bytes", arg, msgbuf, bufsize);
1144 break;
1145 }
1146
1147 case 'Y': { /* PyByteArray object */
1148 PyObject **p = va_arg(*p_va, PyObject **);
1149 if (PyByteArray_Check(arg))
1150 *p = arg;
1151 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001152 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001153 break;
1154 }
1155
1156 case 'U': { /* PyUnicode object */
1157 PyObject **p = va_arg(*p_va, PyObject **);
1158 if (PyUnicode_Check(arg))
1159 *p = arg;
1160 else
1161 return converterr("str", arg, msgbuf, bufsize);
1162 break;
1163 }
1164
1165 case 'O': { /* object */
1166 PyTypeObject *type;
1167 PyObject **p;
1168 if (*format == '!') {
1169 type = va_arg(*p_va, PyTypeObject*);
1170 p = va_arg(*p_va, PyObject **);
1171 format++;
1172 if (PyType_IsSubtype(arg->ob_type, type))
1173 *p = arg;
1174 else
1175 return converterr(type->tp_name, arg, msgbuf, bufsize);
1176
1177 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001178 else if (*format == '&') {
1179 typedef int (*converter)(PyObject *, void *);
1180 converter convert = va_arg(*p_va, converter);
1181 void *addr = va_arg(*p_va, void *);
1182 int res;
1183 format++;
1184 if (! (res = (*convert)(arg, addr)))
1185 return converterr("(unspecified)",
1186 arg, msgbuf, bufsize);
1187 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001188 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 return converterr("(cleanup problem)",
1190 arg, msgbuf, bufsize);
1191 }
1192 else {
1193 p = va_arg(*p_va, PyObject **);
1194 *p = arg;
1195 }
1196 break;
1197 }
1198
1199
Victor Stinner25e8ec42010-06-25 00:02:38 +00001200 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001201 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001202
Victor Stinner25e8ec42010-06-25 00:02:38 +00001203 if (*format != '*')
1204 return converterr(
1205 "invalid use of 'w' format character",
1206 arg, msgbuf, bufsize);
1207 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001208
Victor Stinner25e8ec42010-06-25 00:02:38 +00001209 /* Caller is interested in Py_buffer, and the object
1210 supports it directly. */
1211 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1212 PyErr_Clear();
1213 return converterr("read-write buffer", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001214 }
Victor Stinner8182b712010-07-28 00:40:58 +00001215 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1216 PyBuffer_Release((Py_buffer*)p);
1217 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1218 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001219 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001220 return converterr(
1221 "(cleanup problem)",
1222 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001224 break;
1225 }
1226
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001227 default:
1228 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
1229
1230 }
1231
1232 *p_format = format;
1233 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001234
1235#undef FETCH_SIZE
1236#undef STORE_SIZE
1237#undef BUFFER_LEN
1238#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001239}
Guido van Rossumaa354651996-08-19 19:32:04 +00001240
Martin v. Löwis18e16552006-02-15 17:27:45 +00001241static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001242convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001243{
Victor Stinner5cb62392010-06-06 20:27:51 +00001244 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 Py_ssize_t count;
1246 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 *errmsg = NULL;
1249 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001250 if (pb != NULL && pb->bf_releasebuffer != NULL) {
1251 *errmsg = "read-only pinned buffer";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001252 return -1;
1253 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001254
Victor Stinner8182b712010-07-28 00:40:58 +00001255 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001256 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001257 count = view.len;
1258 *p = view.buf;
1259 PyBuffer_Release(&view);
1260 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001261}
Guido van Rossumaa354651996-08-19 19:32:04 +00001262
Martin v. Löwis423be952008-08-13 15:53:07 +00001263static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001264getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001265{
Victor Stinner8182b712010-07-28 00:40:58 +00001266 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001267 *errmsg = "bytes or buffer";
1268 return -1;
1269 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001270 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001271 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001272 *errmsg = "contiguous buffer";
1273 return -1;
1274 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001275 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001276}
1277
Guido van Rossumaa354651996-08-19 19:32:04 +00001278/* Support for keyword arguments donated by
1279 Geoff Philbrick <philbric@delphi.hks.com> */
1280
Tim Petersf8cd3e82001-10-27 04:26:57 +00001281/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001282int
1283PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001284 PyObject *keywords,
1285 const char *format,
1286 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001287{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001288 int retval;
1289 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001291 if ((args == NULL || !PyTuple_Check(args)) ||
1292 (keywords != NULL && !PyDict_Check(keywords)) ||
1293 format == NULL ||
1294 kwlist == NULL)
1295 {
1296 PyErr_BadInternalCall();
1297 return 0;
1298 }
Tim Peters45772cd2001-10-27 03:58:40 +00001299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001300 va_start(va, kwlist);
1301 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1302 va_end(va);
1303 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001304}
1305
1306int
1307_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001308 PyObject *keywords,
1309 const char *format,
1310 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001311{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001312 int retval;
1313 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001315 if ((args == NULL || !PyTuple_Check(args)) ||
1316 (keywords != NULL && !PyDict_Check(keywords)) ||
1317 format == NULL ||
1318 kwlist == NULL)
1319 {
1320 PyErr_BadInternalCall();
1321 return 0;
1322 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001323
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001324 va_start(va, kwlist);
1325 retval = vgetargskeywords(args, keywords, format,
1326 kwlist, &va, FLAG_SIZE_T);
1327 va_end(va);
1328 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001329}
1330
1331
Brett Cannon711e7d92004-07-10 22:20:32 +00001332int
1333PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001334 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001335 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001336 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001337{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001338 int retval;
1339 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001341 if ((args == NULL || !PyTuple_Check(args)) ||
1342 (keywords != NULL && !PyDict_Check(keywords)) ||
1343 format == NULL ||
1344 kwlist == NULL)
1345 {
1346 PyErr_BadInternalCall();
1347 return 0;
1348 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001349
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001350 Py_VA_COPY(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001351
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001352 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1353 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001354}
1355
1356int
1357_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001358 PyObject *keywords,
1359 const char *format,
1360 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001361{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001362 int retval;
1363 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001365 if ((args == NULL || !PyTuple_Check(args)) ||
1366 (keywords != NULL && !PyDict_Check(keywords)) ||
1367 format == NULL ||
1368 kwlist == NULL)
1369 {
1370 PyErr_BadInternalCall();
1371 return 0;
1372 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001373
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001374 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001375
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001376 retval = vgetargskeywords(args, keywords, format,
1377 kwlist, &lva, FLAG_SIZE_T);
1378 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001379}
1380
Benjamin Petersonfb886362010-04-24 18:21:17 +00001381int
1382PyArg_ValidateKeywordArguments(PyObject *kwargs)
1383{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001384 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001385 PyErr_BadInternalCall();
1386 return 0;
1387 }
1388 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1389 PyErr_SetString(PyExc_TypeError,
1390 "keyword arguments must be strings");
1391 return 0;
1392 }
1393 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001394}
1395
Christian Heimes380f7f22008-02-28 11:19:05 +00001396#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001397
Guido van Rossumaa354651996-08-19 19:32:04 +00001398static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001399vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001401{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 char msgbuf[512];
1403 int levels[32];
1404 const char *fname, *msg, *custom_msg, *keyword;
1405 int min = INT_MAX;
1406 int i, len, nargs, nkeywords;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001407 PyObject *current_arg;
1408 freelist_t freelist = {0, NULL};
Tim Petersf4331c12001-10-27 00:17:34 +00001409
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001410 assert(args != NULL && PyTuple_Check(args));
1411 assert(keywords == NULL || PyDict_Check(keywords));
1412 assert(format != NULL);
1413 assert(kwlist != NULL);
1414 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001415
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001416 /* grab the function name or custom error msg first (mutually exclusive) */
1417 fname = strchr(format, ':');
1418 if (fname) {
1419 fname++;
1420 custom_msg = NULL;
1421 }
1422 else {
1423 custom_msg = strchr(format,';');
1424 if (custom_msg)
1425 custom_msg++;
1426 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 /* scan kwlist and get greatest possible nbr of args */
1429 for (len=0; kwlist[len]; len++)
1430 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001431
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001432 freelist.entries = PyMem_New(freelistentry_t, len);
1433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 nargs = PyTuple_GET_SIZE(args);
1435 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1436 if (nargs + nkeywords > len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +01001437 PyErr_Format(PyExc_TypeError,
1438 "%s%s takes at most %d argument%s (%d given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001439 (fname == NULL) ? "function" : fname,
1440 (fname == NULL) ? "" : "()",
1441 len,
1442 (len == 1) ? "" : "s",
1443 nargs + nkeywords);
1444 return 0;
1445 }
Tim Petersc2f01122001-10-27 07:25:06 +00001446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001447 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1448 for (i = 0; i < len; i++) {
1449 keyword = kwlist[i];
1450 if (*format == '|') {
1451 min = i;
1452 format++;
1453 }
1454 if (IS_END_OF_FORMAT(*format)) {
1455 PyErr_Format(PyExc_RuntimeError,
1456 "More keyword list entries (%d) than "
1457 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001458 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001459 }
1460 current_arg = NULL;
1461 if (nkeywords) {
1462 current_arg = PyDict_GetItemString(keywords, keyword);
1463 }
1464 if (current_arg) {
1465 --nkeywords;
1466 if (i < nargs) {
1467 /* arg present in tuple and in dict */
1468 PyErr_Format(PyExc_TypeError,
1469 "Argument given by name ('%s') "
1470 "and position (%d)",
1471 keyword, i+1);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001472 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001473 }
1474 }
1475 else if (nkeywords && PyErr_Occurred())
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001476 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001477 else if (i < nargs)
1478 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimes380f7f22008-02-28 11:19:05 +00001479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 if (current_arg) {
1481 msg = convertitem(current_arg, &format, p_va, flags,
1482 levels, msgbuf, sizeof(msgbuf), &freelist);
1483 if (msg) {
1484 seterror(i+1, msg, levels, fname, custom_msg);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001485 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001486 }
1487 continue;
1488 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001490 if (i < min) {
1491 PyErr_Format(PyExc_TypeError, "Required argument "
1492 "'%s' (pos %d) not found",
1493 keyword, i+1);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001494 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 }
1496 /* current code reports success when all required args
1497 * fulfilled and no keyword args left, with no further
1498 * validation. XXX Maybe skip this in debug build ?
1499 */
1500 if (!nkeywords)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001501 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001502
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001503 /* We are into optional args, skip thru to any remaining
1504 * keyword args */
1505 msg = skipitem(&format, p_va, flags);
1506 if (msg) {
1507 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1508 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001509 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001510 }
1511 }
Tim Petersb054be42001-10-27 05:07:41 +00001512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001513 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
1514 PyErr_Format(PyExc_RuntimeError,
1515 "more argument specifiers than keyword list entries "
1516 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001517 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 }
Tim Petersc2f01122001-10-27 07:25:06 +00001519
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001520 /* make sure there are no extraneous keyword arguments */
1521 if (nkeywords > 0) {
1522 PyObject *key, *value;
1523 Py_ssize_t pos = 0;
1524 while (PyDict_Next(keywords, &pos, &key, &value)) {
1525 int match = 0;
1526 char *ks;
1527 if (!PyUnicode_Check(key)) {
1528 PyErr_SetString(PyExc_TypeError,
1529 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001530 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001531 }
Victor Stinner93b55132010-05-19 00:54:06 +00001532 /* check that _PyUnicode_AsString() result is not NULL */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 ks = _PyUnicode_AsString(key);
Victor Stinner93b55132010-05-19 00:54:06 +00001534 if (ks != NULL) {
1535 for (i = 0; i < len; i++) {
1536 if (!strcmp(ks, kwlist[i])) {
1537 match = 1;
1538 break;
1539 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 }
1541 }
1542 if (!match) {
1543 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001544 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001546 key);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001547 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 }
1549 }
1550 }
1551
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001552 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001553}
1554
1555
1556static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001557skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001558{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 const char *format = *p_format;
1560 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001561
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001563
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001564 /* simple codes
1565 * The individual types (second arg of va_arg) are irrelevant */
Georg Brandl6dd14612005-09-14 19:29:53 +00001566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 case 'b': /* byte -- very short int */
1568 case 'B': /* byte as bitfield */
1569 case 'h': /* short int */
1570 case 'H': /* short int as bitfield */
1571 case 'i': /* int */
1572 case 'I': /* int sized bitfield */
1573 case 'l': /* long int */
1574 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001575#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001576 case 'L': /* PY_LONG_LONG */
1577 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001578#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001579 case 'f': /* float */
1580 case 'd': /* double */
1581 case 'D': /* complex double */
1582 case 'c': /* char */
1583 case 'C': /* unicode char */
1584 {
1585 (void) va_arg(*p_va, void *);
1586 break;
1587 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 case 'n': /* Py_ssize_t */
1590 {
1591 (void) va_arg(*p_va, Py_ssize_t *);
1592 break;
1593 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001594
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001595 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001596
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597 case 'e': /* string with encoding */
1598 {
1599 (void) va_arg(*p_va, const char *);
1600 if (!(*format == 's' || *format == 't'))
1601 /* after 'e', only 's' and 't' is allowed */
1602 goto err;
1603 format++;
1604 /* explicit fallthrough to string cases */
1605 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 case 's': /* string */
1608 case 'z': /* string or None */
1609 case 'y': /* bytes */
1610 case 'u': /* unicode string */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 case 'w': /* buffer, read-write */
1612 {
1613 (void) va_arg(*p_va, char **);
1614 if (*format == '#') {
1615 if (flags & FLAG_SIZE_T)
1616 (void) va_arg(*p_va, Py_ssize_t *);
1617 else
1618 (void) va_arg(*p_va, int *);
1619 format++;
1620 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1621 format++;
1622 }
1623 break;
1624 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001625
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001626 /* object codes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 case 'S': /* string object */
1629 case 'Y': /* string object */
1630 case 'U': /* unicode string object */
1631 {
1632 (void) va_arg(*p_va, PyObject **);
1633 break;
1634 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001635
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 case 'O': /* object */
1637 {
1638 if (*format == '!') {
1639 format++;
1640 (void) va_arg(*p_va, PyTypeObject*);
1641 (void) va_arg(*p_va, PyObject **);
1642 }
1643 else if (*format == '&') {
1644 typedef int (*converter)(PyObject *, void *);
1645 (void) va_arg(*p_va, converter);
1646 (void) va_arg(*p_va, void *);
1647 format++;
1648 }
1649 else {
1650 (void) va_arg(*p_va, PyObject **);
1651 }
1652 break;
1653 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001654
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001655 case '(': /* bypass tuple, not handled at all previously */
1656 {
1657 char *msg;
1658 for (;;) {
1659 if (*format==')')
1660 break;
1661 if (IS_END_OF_FORMAT(*format))
1662 return "Unmatched left paren in format "
1663 "string";
1664 msg = skipitem(&format, p_va, flags);
1665 if (msg)
1666 return msg;
1667 }
1668 format++;
1669 break;
1670 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001671
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001672 case ')':
1673 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00001674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001676err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001679 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001680
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001681 *p_format = format;
1682 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001683}
Fred Drakee4616e62001-10-23 21:09:29 +00001684
1685
1686int
Martin v. Löwis76246742006-03-01 04:06:10 +00001687PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001688{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 Py_ssize_t i, l;
1690 PyObject **o;
1691 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001692
1693#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001694 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001695#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001696 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001697#endif
1698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001699 assert(min >= 0);
1700 assert(min <= max);
1701 if (!PyTuple_Check(args)) {
1702 PyErr_SetString(PyExc_SystemError,
1703 "PyArg_UnpackTuple() argument list is not a tuple");
1704 return 0;
1705 }
1706 l = PyTuple_GET_SIZE(args);
1707 if (l < min) {
1708 if (name != NULL)
1709 PyErr_Format(
1710 PyExc_TypeError,
1711 "%s expected %s%zd arguments, got %zd",
1712 name, (min == max ? "" : "at least "), min, l);
1713 else
1714 PyErr_Format(
1715 PyExc_TypeError,
1716 "unpacked tuple should have %s%zd elements,"
1717 " but has %zd",
1718 (min == max ? "" : "at least "), min, l);
1719 va_end(vargs);
1720 return 0;
1721 }
1722 if (l > max) {
1723 if (name != NULL)
1724 PyErr_Format(
1725 PyExc_TypeError,
1726 "%s expected %s%zd arguments, got %zd",
1727 name, (min == max ? "" : "at most "), max, l);
1728 else
1729 PyErr_Format(
1730 PyExc_TypeError,
1731 "unpacked tuple should have %s%zd elements,"
1732 " but has %zd",
1733 (min == max ? "" : "at most "), max, l);
1734 va_end(vargs);
1735 return 0;
1736 }
1737 for (i = 0; i < l; i++) {
1738 o = va_arg(vargs, PyObject **);
1739 *o = PyTuple_GET_ITEM(args, i);
1740 }
1741 va_end(vargs);
1742 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001743}
Georg Brandl02c42872005-08-26 06:42:30 +00001744
1745
1746/* For type constructors that don't take keyword args
1747 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001748 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001749 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001750 */
1751int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001752_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001753{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001754 if (kw == NULL)
1755 return 1;
1756 if (!PyDict_CheckExact(kw)) {
1757 PyErr_BadInternalCall();
1758 return 0;
1759 }
1760 if (PyDict_Size(kw) == 0)
1761 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001762
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001763 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1764 funcname);
1765 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001766}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001767#ifdef __cplusplus
1768};
1769#endif