blob: 8dc5e784f5ae70d6ab933d8da758d00ea5afa228 [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
10extern "C" {
11#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 *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000040static char *convertitem(PyObject *, const char **, va_list *, int, int *,
41 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 **);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000047
Tim Petersdbd9ba62000-07-09 03:09:57 +000048static int vgetargskeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000049 const char *, char **, va_list *, int);
Martin v. Löwis18e16552006-02-15 17:27:45 +000050static char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000051
Fred Drake563dfc22001-10-23 14:41:08 +000052int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000053PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000054{
55 int retval;
56 va_list va;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000057
58 va_start(va, format);
Martin v. Löwis18e16552006-02-15 17:27:45 +000059 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
60 va_end(va);
61 return retval;
62}
63
64int
65_PyArg_Parse_SizeT(PyObject *args, char *format, ...)
66{
67 int retval;
68 va_list va;
69
70 va_start(va, format);
71 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000072 va_end(va);
73 return retval;
74}
75
76
Fred Drake563dfc22001-10-23 14:41:08 +000077int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000078PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000079{
80 int retval;
81 va_list va;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000082
83 va_start(va, format);
Guido van Rossum1ae940a1995-01-02 19:04:15 +000084 retval = vgetargs1(args, format, &va, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000085 va_end(va);
86 return retval;
87}
88
Martin v. Löwis18e16552006-02-15 17:27:45 +000089int
90_PyArg_ParseTuple_SizeT(PyObject *args, char *format, ...)
91{
92 int retval;
93 va_list va;
94
95 va_start(va, format);
96 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
97 va_end(va);
98 return retval;
99}
100
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000101
102int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000103PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000104{
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000105 va_list lva;
106
107#ifdef VA_LIST_IS_ARRAY
108 memcpy(lva, va, sizeof(va_list));
109#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000110#ifdef __va_copy
111 __va_copy(lva, va);
112#else
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000113 lva = va;
114#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000115#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000116
117 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000118}
119
Martin v. Löwis18e16552006-02-15 17:27:45 +0000120int
121_PyArg_VaParse_SizeT(PyObject *args, char *format, va_list va)
122{
123 va_list lva;
124
125#ifdef VA_LIST_IS_ARRAY
126 memcpy(lva, va, sizeof(va_list));
127#else
128#ifdef __va_copy
129 __va_copy(lva, va);
130#else
131 lva = va;
132#endif
133#endif
134
135 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
136}
137
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000138
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000139/* Handle cleanup of allocated memory in case of exception */
140
141static int
142addcleanup(void *ptr, PyObject **freelist)
143{
144 PyObject *cobj;
145 if (!*freelist) {
146 *freelist = PyList_New(0);
147 if (!*freelist) {
148 PyMem_FREE(ptr);
149 return -1;
150 }
151 }
152 cobj = PyCObject_FromVoidPtr(ptr, NULL);
153 if (!cobj) {
154 PyMem_FREE(ptr);
155 return -1;
156 }
157 if(PyList_Append(*freelist, cobj)) {
158 PyMem_FREE(ptr);
159 Py_DECREF(cobj);
160 return -1;
161 }
162 Py_DECREF(cobj);
163 return 0;
164}
165
166static int
167cleanreturn(int retval, PyObject *freelist)
168{
169 if(freelist) {
170 if((retval) == 0) {
Martin v. Löwisd96ee902006-02-16 14:37:16 +0000171 Py_ssize_t len = PyList_GET_SIZE(freelist), i;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000172 for (i = 0; i < len; i++)
173 PyMem_FREE(PyCObject_AsVoidPtr(
174 PyList_GET_ITEM(freelist, i)));
175 }
176 Py_DECREF(freelist);
177 }
178 return retval;
179}
180
181
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000182static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000183vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000184{
185 char msgbuf[256];
186 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000187 const char *fname = NULL;
188 const char *message = NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000189 int min = -1;
190 int max = 0;
191 int level = 0;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000192 int endfmt = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000193 const char *formatsave = format;
Martin v. Löwisd96ee902006-02-16 14:37:16 +0000194 Py_ssize_t i, len;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000195 char *msg;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000196 PyObject *freelist = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000197 int compat = flags & FLAG_COMPAT;
198
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000199 assert(compat || (args != (PyObject*)NULL));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000200 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000201
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000202 while (endfmt == 0) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000203 int c = *format++;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000204 switch (c) {
205 case '(':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000206 if (level == 0)
207 max++;
208 level++;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000209 if (level >= 30)
210 Py_FatalError("too many tuple nesting levels "
211 "in argument format string");
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000212 break;
213 case ')':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000214 if (level == 0)
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000215 Py_FatalError("excess ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000216 else
217 level--;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000218 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000219 case '\0':
220 endfmt = 1;
221 break;
222 case ':':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000223 fname = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000224 endfmt = 1;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000225 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000226 case ';':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000227 message = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000228 endfmt = 1;
229 break;
230 default:
231 if (level == 0) {
232 if (c == 'O')
233 max++;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000234 else if (isalpha(Py_CHARMASK(c))) {
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000235 if (c != 'e') /* skip encoded */
236 max++;
237 } else if (c == '|')
238 min = max;
239 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000240 break;
241 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000242 }
243
244 if (level != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000245 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000246
247 if (min < 0)
248 min = max;
249
250 format = formatsave;
251
252 if (compat) {
253 if (max == 0) {
254 if (args == NULL)
255 return 1;
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000256 PyOS_snprintf(msgbuf, sizeof(msgbuf),
257 "%.200s%s takes no arguments",
258 fname==NULL ? "function" : fname,
259 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000260 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000261 return 0;
262 }
263 else if (min == 1 && max == 1) {
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000264 if (args == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000265 PyOS_snprintf(msgbuf, sizeof(msgbuf),
266 "%.200s%s takes at least one argument",
267 fname==NULL ? "function" : fname,
268 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000269 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000270 return 0;
271 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000272 msg = convertitem(args, &format, p_va, flags, levels,
273 msgbuf, sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000274 if (msg == NULL)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000275 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000276 seterror(levels[0], msg, levels+1, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000277 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000278 }
279 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000280 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000281 "old style getargs format uses new features");
282 return 0;
283 }
284 }
285
Guido van Rossum79f25d91997-04-29 20:08:16 +0000286 if (!PyTuple_Check(args)) {
287 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000288 "new style getargs format but argument is not a tuple");
289 return 0;
290 }
291
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000292 len = PyTuple_GET_SIZE(args);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000293
294 if (len < min || max < len) {
295 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000296 PyOS_snprintf(msgbuf, sizeof(msgbuf),
297 "%.150s%s takes %s %d argument%s "
Neal Norwitz20dd93f2006-02-19 19:34:15 +0000298 "(%ld given)",
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000299 fname==NULL ? "function" : fname,
300 fname==NULL ? "" : "()",
301 min==max ? "exactly"
302 : len < min ? "at least" : "at most",
303 len < min ? min : max,
304 (len < min ? min : max) == 1 ? "" : "s",
Neal Norwitz9a276172006-02-20 18:57:39 +0000305 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000306 message = msgbuf;
307 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000308 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000309 return 0;
310 }
311
312 for (i = 0; i < len; i++) {
313 if (*format == '|')
314 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000315 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000316 flags, levels, msgbuf,
317 sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000318 if (msg) {
319 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000320 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000321 }
322 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000323
Neal Norwitz4ac13df2005-12-19 06:10:07 +0000324 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
Guido van Rossum7d4f68c1997-12-19 04:25:23 +0000325 *format != '(' &&
Guido van Rossum231a41e1997-12-09 20:36:39 +0000326 *format != '|' && *format != ':' && *format != ';') {
327 PyErr_Format(PyExc_SystemError,
Guido van Rossum0d6b49e1998-01-19 22:22:44 +0000328 "bad format string: %.200s", formatsave);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000329 return cleanreturn(0, freelist);
Guido van Rossum231a41e1997-12-09 20:36:39 +0000330 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000331
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000332 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000333}
334
335
336
337static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000338seterror(int iarg, const char *msg, int *levels, const char *fname,
339 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000340{
Marc-André Lemburgd4c0a9c2001-11-28 11:47:00 +0000341 char buf[512];
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000342 int i;
343 char *p = buf;
344
Guido van Rossum79f25d91997-04-29 20:08:16 +0000345 if (PyErr_Occurred())
Guido van Rossum64fc6491995-01-21 14:09:37 +0000346 return;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000347 else if (message == NULL) {
348 if (fname != NULL) {
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000349 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000350 p += strlen(p);
351 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000352 if (iarg != 0) {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000353 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000354 "argument %d", iarg);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000355 i = 0;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000356 p += strlen(p);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000357 while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
358 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000359 ", item %d", levels[i]-1);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000360 p += strlen(p);
361 i++;
362 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000363 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000364 else {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000365 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
Ka-Ping Yee20579702001-01-15 22:14:16 +0000366 p += strlen(p);
367 }
Tim Petersfaad5ad2001-12-03 00:43:33 +0000368 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000369 message = buf;
370 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000371 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000372}
373
374
375/* Convert a tuple argument.
376 On entry, *p_format points to the character _after_ the opening '('.
377 On successful exit, *p_format points to the closing ')'.
378 If successful:
379 *p_format and *p_va are updated,
380 *levels and *msgbuf are untouched,
381 and NULL is returned.
382 If the argument is invalid:
383 *p_format is unchanged,
384 *p_va is undefined,
385 *levels is a 0-terminated list of item numbers,
386 *msgbuf contains an error message, whose format is:
Ka-Ping Yee20579702001-01-15 22:14:16 +0000387 "must be <typename1>, not <typename2>", where:
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000388 <typename1> is the name of the expected type, and
389 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000390 and msgbuf is returned.
391*/
392
393static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000394converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
395 int *levels, char *msgbuf, size_t bufsize, int toplevel,
396 PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000397{
398 int level = 0;
399 int n = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000400 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000401 int i;
402
403 for (;;) {
404 int c = *format++;
405 if (c == '(') {
406 if (level == 0)
407 n++;
408 level++;
409 }
410 else if (c == ')') {
411 if (level == 0)
412 break;
413 level--;
414 }
415 else if (c == ':' || c == ';' || c == '\0')
416 break;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000417 else if (level == 0 && isalpha(Py_CHARMASK(c)))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000418 n++;
419 }
420
Ka-Ping Yee20579702001-01-15 22:14:16 +0000421 if (!PySequence_Check(arg) || PyString_Check(arg)) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000422 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000423 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000424 toplevel ? "expected %d arguments, not %.50s" :
425 "must be %d-item sequence, not %.50s",
426 n,
427 arg == Py_None ? "None" : arg->ob_type->tp_name);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000428 return msgbuf;
429 }
430
Jeremy Hylton03657cf2000-07-12 13:05:33 +0000431 if ((i = PySequence_Size(arg)) != n) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000432 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000433 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000434 toplevel ? "expected %d arguments, not %d" :
435 "must be sequence of length %d, not %d",
436 n, i);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000437 return msgbuf;
438 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000439
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000440 format = *p_format;
441 for (i = 0; i < n; i++) {
442 char *msg;
Guido van Rossum66368cc1999-02-17 23:16:43 +0000443 PyObject *item;
444 item = PySequence_GetItem(arg, i);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000445 if (item == NULL) {
446 PyErr_Clear();
447 levels[0] = i+1;
448 levels[1] = 0;
449 strncpy(msgbuf, "is not retrievable", bufsize);
450 return msgbuf;
451 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000452 msg = convertitem(item, &format, p_va, flags, levels+1,
453 msgbuf, bufsize, freelist);
Guido van Rossum66368cc1999-02-17 23:16:43 +0000454 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
455 Py_XDECREF(item);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000456 if (msg != NULL) {
457 levels[0] = i+1;
458 return msg;
459 }
460 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000461
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000462 *p_format = format;
463 return NULL;
464}
465
466
467/* Convert a single item. */
468
469static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000470convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
471 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000472{
473 char *msg;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000474 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000475
476 if (*format == '(' /* ')' */) {
477 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000478 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000479 bufsize, 0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000480 if (msg == NULL)
481 format++;
482 }
483 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000484 msg = convertsimple(arg, &format, p_va, flags,
485 msgbuf, bufsize, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000486 if (msg != NULL)
487 levels[0] = 0;
488 }
489 if (msg == NULL)
490 *p_format = format;
491 return msg;
492}
493
494
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000495
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000496#define UNICODE_DEFAULT_ENCODING(arg) \
497 _PyUnicode_AsDefaultEncodedString(arg, NULL)
498
499/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000500
501static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000502converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000503{
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000504 assert(expected != NULL);
505 assert(arg != NULL);
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000506 PyOS_snprintf(msgbuf, bufsize,
507 "must be %.50s, not %.50s", expected,
508 arg == Py_None ? "None" : arg->ob_type->tp_name);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000509 return msgbuf;
510}
511
512#define CONV_UNICODE "(unicode conversion error)"
513
Guido van Rossum45aecf42006-03-15 04:58:47 +0000514/* Explicitly check for float arguments when integers are expected.
515 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000516static int
517float_argument_error(PyObject *arg)
518{
Guido van Rossum45aecf42006-03-15 04:58:47 +0000519 if (PyFloat_Check(arg)) {
520 PyErr_SetString(PyExc_TypeError,
521 "integer argument expected, got float" );
Neil Schemenauer5042da62003-02-04 20:59:40 +0000522 return 1;
Guido van Rossum45aecf42006-03-15 04:58:47 +0000523 }
Neil Schemenauer5042da62003-02-04 20:59:40 +0000524 else
525 return 0;
526}
527
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000528/* Convert a non-tuple argument. Return NULL if conversion went OK,
529 or a string with a message describing the failure. The message is
530 formatted as "must be <desired type>, not <actual type>".
531 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000532 Don't call if a tuple is expected.
533
534 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000535*/
536
537static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000538convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000539 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000540{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000541 /* For # codes */
542#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
543 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
544 else q=va_arg(*p_va, int*);
545#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
546#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
547
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000548 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000549 char c = *format++;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000550#ifdef Py_USING_UNICODE
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000551 PyObject *uarg;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000552#endif
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000553
554 switch (c) {
555
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000556 case 'b': { /* unsigned byte -- very short int */
557 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000558 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000559 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000560 return converterr("integer<b>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000561 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000562 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000563 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000564 else if (ival < 0) {
565 PyErr_SetString(PyExc_OverflowError,
566 "unsigned byte integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000567 return converterr("integer<b>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000568 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000569 else if (ival > UCHAR_MAX) {
570 PyErr_SetString(PyExc_OverflowError,
571 "unsigned byte integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000572 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000573 }
574 else
575 *p = (unsigned char) ival;
576 break;
577 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000578
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000579 case 'B': {/* byte sized bitfield - both signed and unsigned
580 values allowed */
581 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000582 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000583 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000584 return converterr("integer<B>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000585 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000586 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000587 return converterr("integer<B>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000588 else
589 *p = (unsigned char) ival;
590 break;
591 }
Jack Jansencc22fbe2000-08-05 21:29:58 +0000592
Guido van Rossumfce26e72003-04-18 00:12:30 +0000593 case 'h': {/* signed short int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000594 short *p = va_arg(*p_va, short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000595 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000596 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000597 return converterr("integer<h>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000598 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000599 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000600 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfce26e72003-04-18 00:12:30 +0000601 else if (ival < SHRT_MIN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000602 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000603 "signed short integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000604 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000605 }
Guido van Rossumfce26e72003-04-18 00:12:30 +0000606 else if (ival > SHRT_MAX) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000607 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000608 "signed short integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000609 return converterr("integer<h>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000610 }
611 else
612 *p = (short) ival;
613 break;
614 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000615
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000616 case 'H': { /* short int sized bitfield, both signed and
617 unsigned allowed */
618 unsigned short *p = va_arg(*p_va, unsigned short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000619 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000620 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000621 return converterr("integer<H>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000622 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000623 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000624 return converterr("integer<H>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000625 else
626 *p = (unsigned short) ival;
627 break;
628 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000629
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000630 case 'i': {/* signed int */
631 int *p = va_arg(*p_va, int *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000632 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000633 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000634 return converterr("integer<i>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000635 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000636 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000637 return converterr("integer<i>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000638 else if (ival > INT_MAX) {
639 PyErr_SetString(PyExc_OverflowError,
640 "signed integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000641 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000642 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000643 else if (ival < INT_MIN) {
644 PyErr_SetString(PyExc_OverflowError,
645 "signed integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000646 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000647 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000648 else
649 *p = ival;
650 break;
651 }
652
Thomas Hellera4ea6032003-04-17 18:55:45 +0000653 case 'I': { /* int sized bitfield, both signed and
654 unsigned allowed */
655 unsigned int *p = va_arg(*p_va, unsigned int *);
656 unsigned int ival;
657 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000658 return converterr("integer<I>", arg, msgbuf, bufsize);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000659 ival = (unsigned int)PyInt_AsUnsignedLongMask(arg);
660 if (ival == (unsigned int)-1 && PyErr_Occurred())
Thomas Hellera4ea6032003-04-17 18:55:45 +0000661 return converterr("integer<I>", arg, msgbuf, bufsize);
662 else
663 *p = ival;
664 break;
665 }
666
Martin v. Löwis18e16552006-02-15 17:27:45 +0000667 case 'n': /* Py_ssize_t */
668#if SIZEOF_SIZE_T != SIZEOF_LONG
669 {
670 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
671 Py_ssize_t ival;
672 if (float_argument_error(arg))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000673 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000674 ival = PyInt_AsSsize_t(arg);
675 if (ival == -1 && PyErr_Occurred())
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000676 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000677 *p = ival;
678 break;
679 }
680#endif
681 /* Fall through from 'n' to 'l' if Py_ssize_t is int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000682 case 'l': {/* long int */
683 long *p = va_arg(*p_va, long *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000684 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000685 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000686 return converterr("integer<l>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000687 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000688 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000689 return converterr("integer<l>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000690 else
691 *p = ival;
692 break;
693 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000694
695 case 'k': { /* long sized bitfield */
696 unsigned long *p = va_arg(*p_va, unsigned long *);
697 unsigned long ival;
698 if (PyInt_Check(arg))
699 ival = PyInt_AsUnsignedLongMask(arg);
700 else if (PyLong_Check(arg))
701 ival = PyLong_AsUnsignedLongMask(arg);
702 else
703 return converterr("integer<k>", arg, msgbuf, bufsize);
704 *p = ival;
705 break;
706 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000707
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000708#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000709 case 'L': {/* PY_LONG_LONG */
710 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
711 PY_LONG_LONG ival = PyLong_AsLongLong( arg );
712 if( ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000713 return converterr("long<L>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000714 } else {
715 *p = ival;
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000716 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000717 break;
718 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000719
720 case 'K': { /* long long sized bitfield */
721 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
722 unsigned PY_LONG_LONG ival;
Thomas Hellera4ea6032003-04-17 18:55:45 +0000723 if (PyInt_Check(arg))
724 ival = PyInt_AsUnsignedLongMask(arg);
725 else if (PyLong_Check(arg))
726 ival = PyLong_AsUnsignedLongLongMask(arg);
727 else
728 return converterr("integer<K>", arg, msgbuf, bufsize);
729 *p = ival;
730 break;
731 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000732#endif
733
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000734 case 'f': {/* float */
735 float *p = va_arg(*p_va, float *);
736 double dval = PyFloat_AsDouble(arg);
737 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000738 return converterr("float<f>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000739 else
740 *p = (float) dval;
741 break;
742 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000743
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000744 case 'd': {/* double */
745 double *p = va_arg(*p_va, double *);
746 double dval = PyFloat_AsDouble(arg);
747 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000748 return converterr("float<d>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000749 else
750 *p = dval;
751 break;
752 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000753
Guido van Rossum530956d1996-07-21 02:27:43 +0000754#ifndef WITHOUT_COMPLEX
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000755 case 'D': {/* complex double */
756 Py_complex *p = va_arg(*p_va, Py_complex *);
757 Py_complex cval;
758 cval = PyComplex_AsCComplex(arg);
759 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000760 return converterr("complex<D>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000761 else
762 *p = cval;
763 break;
764 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000765#endif /* WITHOUT_COMPLEX */
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000766
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000767 case 'c': {/* char */
768 char *p = va_arg(*p_va, char *);
769 if (PyString_Check(arg) && PyString_Size(arg) == 1)
Jeremy Hylton0407aea2001-10-10 02:51:57 +0000770 *p = PyString_AS_STRING(arg)[0];
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000771 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000772 return converterr("char", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000773 break;
774 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000775
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000776 case 's': {/* string */
777 if (*format == '#') {
778 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000779 FETCH_SIZE;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000780
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000781 if (PyString_Check(arg)) {
782 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000783 STORE_SIZE(PyString_GET_SIZE(arg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000784 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000785#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000786 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000787 uarg = UNICODE_DEFAULT_ENCODING(arg);
788 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000789 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000790 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000791 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000792 STORE_SIZE(PyString_GET_SIZE(uarg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000793 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000794#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000795 else { /* any buffer-like object */
796 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000797 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000798 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000799 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000800 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000801 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000802 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000803 } else {
804 char **p = va_arg(*p_va, char **);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000805
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000806 if (PyString_Check(arg))
807 *p = PyString_AS_STRING(arg);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000808#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000809 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000810 uarg = UNICODE_DEFAULT_ENCODING(arg);
811 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000812 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000813 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000814 *p = PyString_AS_STRING(uarg);
Marc-André Lemburg6f15e572001-05-02 17:16:16 +0000815 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000816#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000817 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000818 return converterr("string", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000819 if ((int)strlen(*p) != PyString_Size(arg))
820 return converterr("string without null bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000821 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000822 }
823 break;
824 }
825
826 case 'z': {/* string, may be NULL (None) */
827 if (*format == '#') { /* any buffer-like object */
828 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000829 FETCH_SIZE;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000830
831 if (arg == Py_None) {
832 *p = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000833 STORE_SIZE(0);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000834 }
835 else if (PyString_Check(arg)) {
836 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000837 STORE_SIZE(PyString_GET_SIZE(arg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000838 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000839#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000840 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000841 uarg = UNICODE_DEFAULT_ENCODING(arg);
842 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000843 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000844 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000845 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000846 STORE_SIZE(PyString_GET_SIZE(uarg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000847 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000848#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000849 else { /* any buffer-like object */
850 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000851 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000852 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000853 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000854 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000855 }
856 format++;
857 } else {
858 char **p = va_arg(*p_va, char **);
859
860 if (arg == Py_None)
861 *p = 0;
862 else if (PyString_Check(arg))
Jeremy Hyltona4c8cd72001-10-10 02:51:08 +0000863 *p = PyString_AS_STRING(arg);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000864#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000865 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000866 uarg = UNICODE_DEFAULT_ENCODING(arg);
867 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000868 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000869 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000870 *p = PyString_AS_STRING(uarg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000871 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000872#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000873 else
874 return converterr("string or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000875 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000876 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000877 FETCH_SIZE;
Thomas Woutersc3547a32006-03-01 21:31:21 +0000878 assert(0); /* XXX redundant with if-case */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000879 if (arg == Py_None)
880 *q = 0;
881 else
882 *q = PyString_Size(arg);
883 format++;
884 }
885 else if (*p != NULL &&
886 (int)strlen(*p) != PyString_Size(arg))
887 return converterr(
888 "string without null bytes or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000889 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000890 }
891 break;
892 }
893
894 case 'e': {/* encoded string */
895 char **buffer;
896 const char *encoding;
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000897 PyObject *s;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000898 int size, recode_strings;
899
900 /* Get 'e' parameter: the encoding name */
901 encoding = (const char *)va_arg(*p_va, const char *);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000902#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000903 if (encoding == NULL)
904 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000905#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000906
907 /* Get output buffer parameter:
908 's' (recode all objects via Unicode) or
909 't' (only recode non-string objects)
910 */
911 if (*format == 's')
912 recode_strings = 1;
913 else if (*format == 't')
914 recode_strings = 0;
915 else
916 return converterr(
917 "(unknown parser marker combination)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000918 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000919 buffer = (char **)va_arg(*p_va, char **);
920 format++;
921 if (buffer == NULL)
922 return converterr("(buffer is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000923 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000924
925 /* Encode object */
926 if (!recode_strings && PyString_Check(arg)) {
927 s = arg;
928 Py_INCREF(s);
929 }
930 else {
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000931#ifdef Py_USING_UNICODE
932 PyObject *u;
933
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000934 /* Convert object to Unicode */
935 u = PyUnicode_FromObject(arg);
936 if (u == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000937 return converterr(
938 "string or unicode or text buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000939 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000940
941 /* Encode object; use default error handling */
942 s = PyUnicode_AsEncodedString(u,
943 encoding,
944 NULL);
945 Py_DECREF(u);
946 if (s == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000947 return converterr("(encoding failed)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000948 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000949 if (!PyString_Check(s)) {
950 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000951 return converterr(
952 "(encoder failed to return a string)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000953 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000954 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000955#else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000956 return converterr("string<e>", arg, msgbuf, bufsize);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000957#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000958 }
959 size = PyString_GET_SIZE(s);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000960
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000961 /* Write output; output is guaranteed to be 0-terminated */
962 if (*format == '#') {
963 /* Using buffer length parameter '#':
964
965 - if *buffer is NULL, a new buffer of the
966 needed size is allocated and the data
967 copied into it; *buffer is updated to point
968 to the new buffer; the caller is
969 responsible for PyMem_Free()ing it after
970 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000971
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000972 - if *buffer is not NULL, the data is
973 copied to *buffer; *buffer_len has to be
974 set to the size of the buffer on input;
975 buffer overflow is signalled with an error;
976 buffer has to provide enough room for the
977 encoded string plus the trailing 0-byte
978
979 - in both cases, *buffer_len is updated to
980 the size of the buffer /excluding/ the
981 trailing 0-byte
982
983 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000984 FETCH_SIZE;
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000985
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000986 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000987 if (q == NULL && q2 == NULL) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000988 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000989 return converterr(
990 "(buffer_len is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000991 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000992 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000993 if (*buffer == NULL) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000994 *buffer = PyMem_NEW(char, size + 1);
995 if (*buffer == NULL) {
996 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000997 return converterr(
998 "(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000999 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001000 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001001 if(addcleanup(*buffer, freelist)) {
1002 Py_DECREF(s);
1003 return converterr(
1004 "(cleanup problem)",
1005 arg, msgbuf, bufsize);
1006 }
Fred Drake25871c02000-05-03 15:17:02 +00001007 } else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001008 if (size + 1 > BUFFER_LEN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001009 Py_DECREF(s);
1010 return converterr(
1011 "(buffer overflow)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001012 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001013 }
Fred Drake25871c02000-05-03 15:17:02 +00001014 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001015 memcpy(*buffer,
1016 PyString_AS_STRING(s),
1017 size + 1);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001018 STORE_SIZE(size);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001019 } else {
1020 /* Using a 0-terminated buffer:
1021
1022 - the encoded string has to be 0-terminated
1023 for this variant to work; if it is not, an
1024 error raised
Fred Drake25871c02000-05-03 15:17:02 +00001025
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001026 - a new buffer of the needed size is
1027 allocated and the data copied into it;
1028 *buffer is updated to point to the new
1029 buffer; the caller is responsible for
1030 PyMem_Free()ing it after usage
1031
1032 */
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001033 if ((int)strlen(PyString_AS_STRING(s)) != size) {
1034 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001035 return converterr(
1036 "(encoded string without NULL bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001037 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001038 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001039 *buffer = PyMem_NEW(char, size + 1);
1040 if (*buffer == NULL) {
1041 Py_DECREF(s);
1042 return converterr("(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001043 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001044 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001045 if(addcleanup(*buffer, freelist)) {
1046 Py_DECREF(s);
1047 return converterr("(cleanup problem)",
1048 arg, msgbuf, bufsize);
1049 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001050 memcpy(*buffer,
1051 PyString_AS_STRING(s),
1052 size + 1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001053 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001054 Py_DECREF(s);
1055 break;
1056 }
1057
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001058#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001059 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1060 if (*format == '#') { /* any buffer-like object */
1061 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001062 FETCH_SIZE;
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001063 if (PyUnicode_Check(arg)) {
1064 *p = PyUnicode_AS_UNICODE(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001065 STORE_SIZE(PyUnicode_GET_SIZE(arg));
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001066 }
1067 else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001068 return converterr("cannot convert raw buffers",
1069 arg, msgbuf, bufsize);
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001070 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001071 format++;
1072 } else {
1073 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossume826ef02000-03-10 23:02:17 +00001074 if (PyUnicode_Check(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001075 *p = PyUnicode_AS_UNICODE(arg);
1076 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001077 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001078 }
1079 break;
1080 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001081#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001082
1083 case 'S': { /* string object */
1084 PyObject **p = va_arg(*p_va, PyObject **);
1085 if (PyString_Check(arg))
1086 *p = arg;
1087 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001088 return converterr("string", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001089 break;
1090 }
1091
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001092#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001093 case 'U': { /* Unicode object */
1094 PyObject **p = va_arg(*p_va, PyObject **);
1095 if (PyUnicode_Check(arg))
1096 *p = arg;
1097 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001098 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001099 break;
1100 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001101#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001102
1103 case 'O': { /* object */
1104 PyTypeObject *type;
1105 PyObject **p;
1106 if (*format == '!') {
1107 type = va_arg(*p_va, PyTypeObject*);
1108 p = va_arg(*p_va, PyObject **);
1109 format++;
Guido van Rossumcbfc8552001-08-28 16:37:51 +00001110 if (PyType_IsSubtype(arg->ob_type, type))
Guido van Rossume826ef02000-03-10 23:02:17 +00001111 *p = arg;
1112 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001113 return converterr(type->tp_name, arg, msgbuf, bufsize);
Guido van Rossumfccfe891998-05-15 22:04:07 +00001114
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001115 }
1116 else if (*format == '?') {
1117 inquiry pred = va_arg(*p_va, inquiry);
1118 p = va_arg(*p_va, PyObject **);
1119 format++;
1120 if ((*pred)(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001121 *p = arg;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001122 else
1123 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001124 arg, msgbuf, bufsize);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001125
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001126 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001127 else if (*format == '&') {
1128 typedef int (*converter)(PyObject *, void *);
1129 converter convert = va_arg(*p_va, converter);
1130 void *addr = va_arg(*p_va, void *);
1131 format++;
1132 if (! (*convert)(arg, addr))
1133 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001134 arg, msgbuf, bufsize);
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001135 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001136 else {
1137 p = va_arg(*p_va, PyObject **);
1138 *p = arg;
1139 }
1140 break;
1141 }
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001142
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001143
1144 case 'w': { /* memory buffer, read-write access */
1145 void **p = va_arg(*p_va, void **);
1146 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1147 int count;
1148
1149 if (pb == NULL ||
1150 pb->bf_getwritebuffer == NULL ||
1151 pb->bf_getsegcount == NULL)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001152 return converterr("read-write buffer", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001153 if ((*pb->bf_getsegcount)(arg, NULL) != 1)
1154 return converterr("single-segment read-write buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001155 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001156 if ((count = pb->bf_getwritebuffer(arg, 0, p)) < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001157 return converterr("(unspecified)", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001158 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001159 FETCH_SIZE;
1160 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001161 format++;
1162 }
1163 break;
1164 }
1165
1166 case 't': { /* 8-bit character buffer, read-only access */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001167 char **p = va_arg(*p_va, char **);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001168 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001169 int count;
1170
1171 if (*format++ != '#')
1172 return converterr(
1173 "invalid use of 't' format character",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001174 arg, msgbuf, bufsize);
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001175 if (pb == NULL || pb->bf_getcharbuffer == NULL ||
Jeremy Hylton4819e972001-10-11 14:40:37 +00001176 pb->bf_getsegcount == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001177 return converterr(
1178 "string or read-only character buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001179 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001180
Jeremy Hylton4819e972001-10-11 14:40:37 +00001181 if (pb->bf_getsegcount(arg, NULL) != 1)
1182 return converterr(
1183 "string or single-segment read-only buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001184 arg, msgbuf, bufsize);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001185
1186 count = pb->bf_getcharbuffer(arg, 0, p);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001187 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001188 return converterr("(unspecified)", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001189 {
1190 FETCH_SIZE;
1191 STORE_SIZE(count);
1192 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001193 break;
1194 }
1195
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001196 default:
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001197 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001198
1199 }
1200
1201 *p_format = format;
1202 return NULL;
1203}
Guido van Rossumaa354651996-08-19 19:32:04 +00001204
Martin v. Löwis18e16552006-02-15 17:27:45 +00001205static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001206convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001207{
1208 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001209 Py_ssize_t count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001210 if (pb == NULL ||
1211 pb->bf_getreadbuffer == NULL ||
1212 pb->bf_getsegcount == NULL) {
1213 *errmsg = "string or read-only buffer";
1214 return -1;
1215 }
1216 if ((*pb->bf_getsegcount)(arg, NULL) != 1) {
1217 *errmsg = "string or single-segment read-only buffer";
1218 return -1;
1219 }
1220 if ((count = (*pb->bf_getreadbuffer)(arg, 0, p)) < 0) {
1221 *errmsg = "(unspecified)";
1222 }
1223 return count;
1224}
Guido van Rossumaa354651996-08-19 19:32:04 +00001225
1226/* Support for keyword arguments donated by
1227 Geoff Philbrick <philbric@delphi.hks.com> */
1228
Tim Petersf8cd3e82001-10-27 04:26:57 +00001229/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001230int
1231PyArg_ParseTupleAndKeywords(PyObject *args,
1232 PyObject *keywords,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001233 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001234 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001235{
1236 int retval;
1237 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001238
1239 if ((args == NULL || !PyTuple_Check(args)) ||
1240 (keywords != NULL && !PyDict_Check(keywords)) ||
1241 format == NULL ||
1242 kwlist == NULL)
1243 {
1244 PyErr_BadInternalCall();
Tim Petersf8cd3e82001-10-27 04:26:57 +00001245 return 0;
Tim Peters45772cd2001-10-27 03:58:40 +00001246 }
1247
Guido van Rossumaa354651996-08-19 19:32:04 +00001248 va_start(va, kwlist);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001249 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1250 va_end(va);
1251 return retval;
1252}
1253
1254int
1255_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1256 PyObject *keywords,
1257 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001258 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001259{
1260 int retval;
1261 va_list va;
1262
1263 if ((args == NULL || !PyTuple_Check(args)) ||
1264 (keywords != NULL && !PyDict_Check(keywords)) ||
1265 format == NULL ||
1266 kwlist == NULL)
1267 {
1268 PyErr_BadInternalCall();
1269 return 0;
1270 }
1271
1272 va_start(va, kwlist);
1273 retval = vgetargskeywords(args, keywords, format,
1274 kwlist, &va, FLAG_SIZE_T);
Guido van Rossumaa354651996-08-19 19:32:04 +00001275 va_end(va);
1276 return retval;
1277}
1278
1279
Brett Cannon711e7d92004-07-10 22:20:32 +00001280int
1281PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001282 PyObject *keywords,
1283 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001284 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001285{
1286 int retval;
1287 va_list lva;
1288
1289 if ((args == NULL || !PyTuple_Check(args)) ||
1290 (keywords != NULL && !PyDict_Check(keywords)) ||
1291 format == NULL ||
1292 kwlist == NULL)
1293 {
1294 PyErr_BadInternalCall();
1295 return 0;
1296 }
1297
1298#ifdef VA_LIST_IS_ARRAY
1299 memcpy(lva, va, sizeof(va_list));
1300#else
1301#ifdef __va_copy
1302 __va_copy(lva, va);
1303#else
1304 lva = va;
1305#endif
1306#endif
1307
Martin v. Löwis18e16552006-02-15 17:27:45 +00001308 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1309 return retval;
1310}
1311
1312int
1313_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1314 PyObject *keywords,
1315 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001316 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001317{
1318 int retval;
1319 va_list lva;
1320
1321 if ((args == NULL || !PyTuple_Check(args)) ||
1322 (keywords != NULL && !PyDict_Check(keywords)) ||
1323 format == NULL ||
1324 kwlist == NULL)
1325 {
1326 PyErr_BadInternalCall();
1327 return 0;
1328 }
1329
1330#ifdef VA_LIST_IS_ARRAY
1331 memcpy(lva, va, sizeof(va_list));
1332#else
1333#ifdef __va_copy
1334 __va_copy(lva, va);
1335#else
1336 lva = va;
1337#endif
1338#endif
1339
1340 retval = vgetargskeywords(args, keywords, format,
1341 kwlist, &lva, FLAG_SIZE_T);
Brett Cannon711e7d92004-07-10 22:20:32 +00001342 return retval;
1343}
1344
1345
Guido van Rossumaa354651996-08-19 19:32:04 +00001346static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001347vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001348 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001349{
Tim Petersdc5eff92001-10-27 06:53:00 +00001350 char msgbuf[512];
Guido van Rossumaa354651996-08-19 19:32:04 +00001351 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001352 const char *fname, *message;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001353 int min, max;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001354 const char *formatsave;
Tim Petersb639d492001-10-27 07:00:56 +00001355 int i, len, nargs, nkeywords;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001356 const char *msg;
1357 char **p;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001358 PyObject *freelist = NULL;
Tim Petersf4331c12001-10-27 00:17:34 +00001359
Tim Peters45772cd2001-10-27 03:58:40 +00001360 assert(args != NULL && PyTuple_Check(args));
1361 assert(keywords == NULL || PyDict_Check(keywords));
1362 assert(format != NULL);
1363 assert(kwlist != NULL);
1364 assert(p_va != NULL);
1365
Tim Petersf8cd3e82001-10-27 04:26:57 +00001366 /* Search the format:
1367 message <- error msg, if any (else NULL).
Tim Peterscffed4b2001-11-29 03:26:37 +00001368 fname <- routine name, if any (else NULL).
Tim Petersf8cd3e82001-10-27 04:26:57 +00001369 min <- # of required arguments, or -1 if all are required.
1370 max <- most arguments (required + optional).
Tim Peters62d48e12001-10-27 06:42:16 +00001371 Check that kwlist has a non-NULL entry for each arg.
Tim Petersf8cd3e82001-10-27 04:26:57 +00001372 Raise error if a tuple arg spec is found.
1373 */
1374 fname = message = NULL;
Tim Peters6fb26352001-10-27 04:38:11 +00001375 formatsave = format;
Tim Peters62d48e12001-10-27 06:42:16 +00001376 p = kwlist;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001377 min = -1;
1378 max = 0;
1379 while ((i = *format++) != '\0') {
Neal Norwitz30b5c5d2005-12-19 06:05:18 +00001380 if (isalpha(Py_CHARMASK(i)) && i != 'e') {
Tim Petersf8cd3e82001-10-27 04:26:57 +00001381 max++;
Tim Peters62d48e12001-10-27 06:42:16 +00001382 if (*p == NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001383 PyErr_SetString(PyExc_RuntimeError,
1384 "more argument specifiers than "
1385 "keyword list entries");
Tim Peters62d48e12001-10-27 06:42:16 +00001386 return 0;
1387 }
1388 p++;
1389 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001390 else if (i == '|')
1391 min = max;
1392 else if (i == ':') {
1393 fname = format;
1394 break;
1395 }
1396 else if (i == ';') {
1397 message = format;
1398 break;
1399 }
1400 else if (i == '(') {
Tim Peterscffed4b2001-11-29 03:26:37 +00001401 PyErr_SetString(PyExc_RuntimeError,
1402 "tuple found in format when using keyword "
1403 "arguments");
Guido van Rossumaa354651996-08-19 19:32:04 +00001404 return 0;
1405 }
Tim Peters62d48e12001-10-27 06:42:16 +00001406 }
1407 format = formatsave;
1408 if (*p != NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001409 PyErr_SetString(PyExc_RuntimeError,
1410 "more keyword list entries than "
1411 "argument specifiers");
Tim Peters62d48e12001-10-27 06:42:16 +00001412 return 0;
1413 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001414 if (min < 0) {
1415 /* All arguments are required. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001416 min = max;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001417 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001418
Tim Peters6fb26352001-10-27 04:38:11 +00001419 nargs = PyTuple_GET_SIZE(args);
Tim Petersb0872fc2001-10-27 04:45:34 +00001420 nkeywords = keywords == NULL ? 0 : PyDict_Size(keywords);
Tim Petersf8cd3e82001-10-27 04:26:57 +00001421
Guido van Rossumaa354651996-08-19 19:32:04 +00001422 /* make sure there are no duplicate values for an argument;
1423 its not clear when to use the term "keyword argument vs.
1424 keyword parameter in messages */
Tim Petersb054be42001-10-27 05:07:41 +00001425 if (nkeywords > 0) {
Tim Peters6fb26352001-10-27 04:38:11 +00001426 for (i = 0; i < nargs; i++) {
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001427 const char *thiskw = kwlist[i];
Tim Petersa9f47392001-10-27 00:46:09 +00001428 if (thiskw == NULL)
1429 break;
Tim Peters077f5742001-10-27 05:50:39 +00001430 if (PyDict_GetItemString(keywords, thiskw)) {
Tim Petersb054be42001-10-27 05:07:41 +00001431 PyErr_Format(PyExc_TypeError,
1432 "keyword parameter '%s' was given "
1433 "by position and by name",
Tim Petersa9f47392001-10-27 00:46:09 +00001434 thiskw);
Guido van Rossumaa354651996-08-19 19:32:04 +00001435 return 0;
1436 }
Tim Peters0af49162001-10-27 06:14:32 +00001437 else if (PyErr_Occurred())
1438 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001439 }
1440 }
Tim Peters61dde632001-10-27 05:30:17 +00001441
Guido van Rossumaa354651996-08-19 19:32:04 +00001442 /* required arguments missing from args can be supplied by keyword
Georg Brandld7048172006-01-20 17:53:27 +00001443 arguments; set len to the number of positional arguments, and,
Tim Peters62d48e12001-10-27 06:42:16 +00001444 if that's less than the minimum required, add in the number of
1445 required arguments that are supplied by keywords */
Tim Peters6fb26352001-10-27 04:38:11 +00001446 len = nargs;
Tim Peters62d48e12001-10-27 06:42:16 +00001447 if (nkeywords > 0 && nargs < min) {
Tim Peters6fb26352001-10-27 04:38:11 +00001448 for (i = nargs; i < min; i++) {
Tim Peters077f5742001-10-27 05:50:39 +00001449 if (PyDict_GetItemString(keywords, kwlist[i]))
Guido van Rossumaa354651996-08-19 19:32:04 +00001450 len++;
Tim Peters0af49162001-10-27 06:14:32 +00001451 else if (PyErr_Occurred())
1452 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001453 }
1454 }
Tim Peters0af49162001-10-27 06:14:32 +00001455
Guido van Rossumaa354651996-08-19 19:32:04 +00001456 /* make sure we got an acceptable number of arguments; the message
1457 is a little confusing with keywords since keyword arguments
1458 which are supplied, but don't match the required arguments
Michael W. Hudson5253c302005-03-30 16:41:55 +00001459 are not included in the "%d given" part of the message
1460 XXX and this isn't a bug!? */
Guido van Rossumaa354651996-08-19 19:32:04 +00001461 if (len < min || max < len) {
1462 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +00001463 PyOS_snprintf(msgbuf, sizeof(msgbuf),
1464 "%.200s%s takes %s %d argument%s "
1465 "(%d given)",
1466 fname==NULL ? "function" : fname,
1467 fname==NULL ? "" : "()",
1468 min==max ? "exactly"
1469 : len < min ? "at least" : "at most",
1470 len < min ? min : max,
1471 (len < min ? min : max) == 1 ? "" : "s",
1472 len);
Guido van Rossumaa354651996-08-19 19:32:04 +00001473 message = msgbuf;
1474 }
1475 PyErr_SetString(PyExc_TypeError, message);
1476 return 0;
1477 }
Tim Petersc2f01122001-10-27 07:25:06 +00001478
1479 /* convert the positional arguments */
Tim Peters6fb26352001-10-27 04:38:11 +00001480 for (i = 0; i < nargs; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001481 if (*format == '|')
1482 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +00001483 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001484 flags, levels, msgbuf, sizeof(msgbuf),
1485 &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001486 if (msg) {
1487 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001488 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001489 }
1490 }
1491
Tim Petersc2f01122001-10-27 07:25:06 +00001492 /* handle no keyword parameters in call */
Tim Petersb054be42001-10-27 05:07:41 +00001493 if (nkeywords == 0)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001494 return cleanreturn(1, freelist);
Tim Petersb054be42001-10-27 05:07:41 +00001495
Guido van Rossumaa354651996-08-19 19:32:04 +00001496 /* convert the keyword arguments; this uses the format
1497 string where it was left after processing args */
Tim Petersb639d492001-10-27 07:00:56 +00001498 for (i = nargs; i < max; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001499 PyObject *item;
Guido van Rossumaa354651996-08-19 19:32:04 +00001500 if (*format == '|')
1501 format++;
Tim Peters077f5742001-10-27 05:50:39 +00001502 item = PyDict_GetItemString(keywords, kwlist[i]);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001503 if (item != NULL) {
Tim Peters077f5742001-10-27 05:50:39 +00001504 Py_INCREF(item);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001505 msg = convertitem(item, &format, p_va, flags, levels,
1506 msgbuf, sizeof(msgbuf), &freelist);
Tim Peters077f5742001-10-27 05:50:39 +00001507 Py_DECREF(item);
Guido van Rossumaa354651996-08-19 19:32:04 +00001508 if (msg) {
1509 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001510 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001511 }
Tim Petersc2f01122001-10-27 07:25:06 +00001512 --nkeywords;
1513 if (nkeywords == 0)
1514 break;
Guido van Rossumaa354651996-08-19 19:32:04 +00001515 }
Tim Peters0af49162001-10-27 06:14:32 +00001516 else if (PyErr_Occurred())
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001517 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001518 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001519 msg = skipitem(&format, p_va, flags);
Guido van Rossumaa354651996-08-19 19:32:04 +00001520 if (msg) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001521 levels[0] = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001522 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001523 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001524 }
1525 }
1526 }
Tim Petersb054be42001-10-27 05:07:41 +00001527
Guido van Rossumaa354651996-08-19 19:32:04 +00001528 /* make sure there are no extraneous keyword arguments */
Tim Petersc2f01122001-10-27 07:25:06 +00001529 if (nkeywords > 0) {
1530 PyObject *key, *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001531 Py_ssize_t pos = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001532 while (PyDict_Next(keywords, &pos, &key, &value)) {
Tim Petersc2f01122001-10-27 07:25:06 +00001533 int match = 0;
Guido van Rossum55474762002-04-04 16:22:30 +00001534 char *ks;
1535 if (!PyString_Check(key)) {
1536 PyErr_SetString(PyExc_TypeError,
1537 "keywords must be strings");
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001538 return cleanreturn(0, freelist);
Guido van Rossum55474762002-04-04 16:22:30 +00001539 }
1540 ks = PyString_AsString(key);
Tim Petersb639d492001-10-27 07:00:56 +00001541 for (i = 0; i < max; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001542 if (!strcmp(ks, kwlist[i])) {
1543 match = 1;
1544 break;
1545 }
1546 }
1547 if (!match) {
Tim Petersc2f01122001-10-27 07:25:06 +00001548 PyErr_Format(PyExc_TypeError,
1549 "'%s' is an invalid keyword "
1550 "argument for this function",
1551 ks);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001552 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001553 }
1554 }
1555 }
Tim Petersc2f01122001-10-27 07:25:06 +00001556
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001557 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001558}
1559
1560
1561static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001562skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001563{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001564 const char *format = *p_format;
Guido van Rossumaa354651996-08-19 19:32:04 +00001565 char c = *format++;
1566
1567 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001568
1569 /* simple codes
1570 * The individual types (second arg of va_arg) are irrelevant */
1571
Guido van Rossumaa354651996-08-19 19:32:04 +00001572 case 'b': /* byte -- very short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001573 case 'B': /* byte as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001574 case 'h': /* short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001575 case 'H': /* short int as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001576 case 'i': /* int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001577 case 'I': /* int sized bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001578 case 'l': /* long int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001579 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001580#ifdef HAVE_LONG_LONG
Georg Brandl6dd14612005-09-14 19:29:53 +00001581 case 'L': /* PY_LONG_LONG */
1582 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001583#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001584 case 'f': /* float */
Guido van Rossumaa354651996-08-19 19:32:04 +00001585 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001586#ifndef WITHOUT_COMPLEX
1587 case 'D': /* complex double */
Georg Brandl6dd14612005-09-14 19:29:53 +00001588#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001589 case 'c': /* char */
1590 {
Georg Brandl6dd14612005-09-14 19:29:53 +00001591 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001592 break;
1593 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001594
1595 case 'n': /* Py_ssize_t */
1596 {
1597 (void) va_arg(*p_va, Py_ssize_t *);
1598 break;
1599 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001600
Georg Brandl6dd14612005-09-14 19:29:53 +00001601 /* string codes */
1602
1603 case 'e': /* string with encoding */
1604 {
1605 (void) va_arg(*p_va, const char *);
1606 if (!(*format == 's' || *format == 't'))
1607 /* after 'e', only 's' and 't' is allowed */
1608 goto err;
1609 format++;
1610 /* explicit fallthrough to string cases */
1611 }
1612
Guido van Rossumaa354651996-08-19 19:32:04 +00001613 case 's': /* string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001614 case 'z': /* string or None */
1615#ifdef Py_USING_UNICODE
1616 case 'u': /* unicode string */
1617#endif
1618 case 't': /* buffer, read-only */
1619 case 'w': /* buffer, read-write */
Guido van Rossumaa354651996-08-19 19:32:04 +00001620 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001621 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001622 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001623 if (flags & FLAG_SIZE_T)
1624 (void) va_arg(*p_va, Py_ssize_t *);
1625 else
1626 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001627 format++;
1628 }
1629 break;
1630 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001631
1632 /* object codes */
1633
Guido van Rossumaa354651996-08-19 19:32:04 +00001634 case 'S': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001635#ifdef Py_USING_UNICODE
1636 case 'U': /* unicode string object */
1637#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001638 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001639 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001640 break;
1641 }
1642
1643 case 'O': /* object */
1644 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001645 if (*format == '!') {
1646 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001647 (void) va_arg(*p_va, PyTypeObject*);
1648 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001649 }
1650#if 0
1651/* I don't know what this is for */
1652 else if (*format == '?') {
1653 inquiry pred = va_arg(*p_va, inquiry);
1654 format++;
1655 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001656 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001657 }
1658 }
1659#endif
1660 else if (*format == '&') {
Tim Petersdbd9ba62000-07-09 03:09:57 +00001661 typedef int (*converter)(PyObject *, void *);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001662 (void) va_arg(*p_va, converter);
1663 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001664 format++;
1665 }
1666 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001667 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001668 }
1669 break;
1670 }
1671
1672 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001673err:
Guido van Rossumaa354651996-08-19 19:32:04 +00001674 return "impossible<bad format char>";
1675
1676 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001677
1678 /* The "(...)" format code for tuples is not handled here because
1679 * it is not allowed with keyword args. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001680
1681 *p_format = format;
1682 return NULL;
1683}
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{
Martin v. Löwis76246742006-03-01 04:06:10 +00001689 Py_ssize_t i, l;
Fred Drakee4616e62001-10-23 21:09:29 +00001690 PyObject **o;
1691 va_list vargs;
1692
1693#ifdef HAVE_STDARG_PROTOTYPES
1694 va_start(vargs, max);
1695#else
1696 va_start(vargs);
1697#endif
1698
1699 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,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001711 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001712 name, (min == max ? "" : "at least "), min, l);
1713 else
1714 PyErr_Format(
1715 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001716 "unpacked tuple should have %s%zd elements,"
1717 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001718 (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,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001726 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001727 name, (min == max ? "" : "at most "), max, l);
1728 else
1729 PyErr_Format(
1730 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001731 "unpacked tuple should have %s%zd elements,"
1732 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001733 (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;
1743}
Georg Brandl02c42872005-08-26 06:42:30 +00001744
1745
1746/* For type constructors that don't take keyword args
1747 *
1748 * Sets a TypeError and returns 0 if the kwds dict is
1749 * not emtpy, returns 1 otherwise
1750 */
1751int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001752_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001753{
1754 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;
1762
1763 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1764 funcname);
1765 return 0;
1766}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001767#ifdef __cplusplus
1768};
1769#endif