blob: 8608684e37f1af5089ea8b00a3ed50e4463ed39f [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++;
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000550 PyObject *uarg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000551
552 switch (c) {
553
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000554 case 'b': { /* unsigned byte -- very short int */
555 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000556 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000557 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000558 return converterr("integer<b>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000559 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000560 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000561 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000562 else if (ival < 0) {
563 PyErr_SetString(PyExc_OverflowError,
564 "unsigned byte integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000565 return converterr("integer<b>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000566 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000567 else if (ival > UCHAR_MAX) {
568 PyErr_SetString(PyExc_OverflowError,
569 "unsigned byte integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000570 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000571 }
572 else
573 *p = (unsigned char) ival;
574 break;
575 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000576
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000577 case 'B': {/* byte sized bitfield - both signed and unsigned
578 values allowed */
579 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000580 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000581 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000582 return converterr("integer<B>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000583 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000584 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000585 return converterr("integer<B>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000586 else
587 *p = (unsigned char) ival;
588 break;
589 }
Jack Jansencc22fbe2000-08-05 21:29:58 +0000590
Guido van Rossumfce26e72003-04-18 00:12:30 +0000591 case 'h': {/* signed short int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000592 short *p = va_arg(*p_va, short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000593 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000594 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000595 return converterr("integer<h>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000596 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000597 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000598 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfce26e72003-04-18 00:12:30 +0000599 else if (ival < SHRT_MIN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000600 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000601 "signed short integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000602 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000603 }
Guido van Rossumfce26e72003-04-18 00:12:30 +0000604 else if (ival > SHRT_MAX) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000605 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000606 "signed short integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000607 return converterr("integer<h>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000608 }
609 else
610 *p = (short) ival;
611 break;
612 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000613
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000614 case 'H': { /* short int sized bitfield, both signed and
615 unsigned allowed */
616 unsigned short *p = va_arg(*p_va, unsigned short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000617 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000618 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000619 return converterr("integer<H>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000620 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000621 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000622 return converterr("integer<H>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000623 else
624 *p = (unsigned short) ival;
625 break;
626 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000627
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000628 case 'i': {/* signed int */
629 int *p = va_arg(*p_va, int *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000630 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000631 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000632 return converterr("integer<i>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000633 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000634 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000635 return converterr("integer<i>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000636 else if (ival > INT_MAX) {
637 PyErr_SetString(PyExc_OverflowError,
638 "signed integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000639 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000640 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000641 else if (ival < INT_MIN) {
642 PyErr_SetString(PyExc_OverflowError,
643 "signed integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000644 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000645 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000646 else
647 *p = ival;
648 break;
649 }
650
Thomas Hellera4ea6032003-04-17 18:55:45 +0000651 case 'I': { /* int sized bitfield, both signed and
652 unsigned allowed */
653 unsigned int *p = va_arg(*p_va, unsigned int *);
654 unsigned int ival;
655 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000656 return converterr("integer<I>", arg, msgbuf, bufsize);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000657 ival = (unsigned int)PyInt_AsUnsignedLongMask(arg);
658 if (ival == (unsigned int)-1 && PyErr_Occurred())
Thomas Hellera4ea6032003-04-17 18:55:45 +0000659 return converterr("integer<I>", arg, msgbuf, bufsize);
660 else
661 *p = ival;
662 break;
663 }
664
Martin v. Löwis18e16552006-02-15 17:27:45 +0000665 case 'n': /* Py_ssize_t */
666#if SIZEOF_SIZE_T != SIZEOF_LONG
667 {
Neal Norwitzb879f572007-08-31 05:20:36 +0000668 PyObject *iobj;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000669 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
Neal Norwitzb879f572007-08-31 05:20:36 +0000670 Py_ssize_t ival = -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000671 if (float_argument_error(arg))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000672 return converterr("integer<n>", arg, msgbuf, bufsize);
Neal Norwitzb879f572007-08-31 05:20:36 +0000673 iobj = PyNumber_Index(arg);
674 if (iobj != NULL)
Neal Norwitz64fd6fb2007-08-31 05:32:33 +0000675 ival = PyInt_AsSsize_t(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000676 if (ival == -1 && PyErr_Occurred())
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000677 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000678 *p = ival;
679 break;
680 }
681#endif
682 /* Fall through from 'n' to 'l' if Py_ssize_t is int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000683 case 'l': {/* long int */
684 long *p = va_arg(*p_va, long *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000685 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000686 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000687 return converterr("integer<l>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000688 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000689 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000690 return converterr("integer<l>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000691 else
692 *p = ival;
693 break;
694 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000695
696 case 'k': { /* long sized bitfield */
697 unsigned long *p = va_arg(*p_va, unsigned long *);
698 unsigned long ival;
699 if (PyInt_Check(arg))
700 ival = PyInt_AsUnsignedLongMask(arg);
701 else if (PyLong_Check(arg))
702 ival = PyLong_AsUnsignedLongMask(arg);
703 else
704 return converterr("integer<k>", arg, msgbuf, bufsize);
705 *p = ival;
706 break;
707 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000708
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000709#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000710 case 'L': {/* PY_LONG_LONG */
711 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
712 PY_LONG_LONG ival = PyLong_AsLongLong( arg );
713 if( ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000714 return converterr("long<L>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000715 } else {
716 *p = ival;
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000717 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000718 break;
719 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000720
721 case 'K': { /* long long sized bitfield */
722 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
723 unsigned PY_LONG_LONG ival;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000724 if (PyLong_Check(arg))
Thomas Hellera4ea6032003-04-17 18:55:45 +0000725 ival = PyLong_AsUnsignedLongLongMask(arg);
726 else
727 return converterr("integer<K>", arg, msgbuf, bufsize);
728 *p = ival;
729 break;
730 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000731#endif
732
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000733 case 'f': {/* float */
734 float *p = va_arg(*p_va, float *);
735 double dval = PyFloat_AsDouble(arg);
736 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000737 return converterr("float<f>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000738 else
739 *p = (float) dval;
740 break;
741 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000742
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000743 case 'd': {/* double */
744 double *p = va_arg(*p_va, double *);
745 double dval = PyFloat_AsDouble(arg);
746 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000747 return converterr("float<d>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000748 else
749 *p = dval;
750 break;
751 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000752
Guido van Rossum530956d1996-07-21 02:27:43 +0000753#ifndef WITHOUT_COMPLEX
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000754 case 'D': {/* complex double */
755 Py_complex *p = va_arg(*p_va, Py_complex *);
756 Py_complex cval;
757 cval = PyComplex_AsCComplex(arg);
758 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000759 return converterr("complex<D>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000760 else
761 *p = cval;
762 break;
763 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000764#endif /* WITHOUT_COMPLEX */
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000765
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000766 case 'c': {/* char */
Walter Dörwaldd0941302007-07-01 21:58:22 +0000767 char *p = va_arg(*p_va, char *);
768 if (PyString_Check(arg) && PyString_Size(arg) == 1)
769 *p = PyString_AS_STRING(arg)[0];
770 else if (PyUnicode_Check(arg) &&
771 PyUnicode_GET_SIZE(arg) == 1 &&
772 PyUnicode_AS_UNICODE(arg)[0] < 256)
773 *p = PyUnicode_AS_UNICODE(arg)[0];
774 else
775 return converterr("char < 256", arg, msgbuf, bufsize);
776 break;
777 }
778
779 case 'C': {/* unicode char */
Walter Dörwaldbc1f8862007-06-20 11:02:38 +0000780 int *p = va_arg(*p_va, int *);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000781 if (PyString_Check(arg) && PyString_Size(arg) == 1)
Jeremy Hylton0407aea2001-10-10 02:51:57 +0000782 *p = PyString_AS_STRING(arg)[0];
Guido van Rossum09dc34f2007-05-04 04:17:33 +0000783 else if (PyUnicode_Check(arg) &&
Walter Dörwaldbc1f8862007-06-20 11:02:38 +0000784 PyUnicode_GET_SIZE(arg) == 1)
Guido van Rossum09dc34f2007-05-04 04:17:33 +0000785 *p = PyUnicode_AS_UNICODE(arg)[0];
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000786 else
Walter Dörwaldbc1f8862007-06-20 11:02:38 +0000787 return converterr("char", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000788 break;
789 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000790
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000791 case 's': {/* string */
792 if (*format == '#') {
793 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000794 FETCH_SIZE;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000795
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000796 if (PyString_Check(arg)) {
797 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000798 STORE_SIZE(PyString_GET_SIZE(arg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000799 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000800 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000801 uarg = UNICODE_DEFAULT_ENCODING(arg);
802 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000803 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000804 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000805 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000806 STORE_SIZE(PyString_GET_SIZE(uarg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000807 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000808 else { /* any buffer-like object */
809 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000810 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000811 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000812 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000813 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000814 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000815 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000816 } else {
817 char **p = va_arg(*p_va, char **);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000818
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000819 if (PyString_Check(arg))
820 *p = PyString_AS_STRING(arg);
821 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000822 uarg = UNICODE_DEFAULT_ENCODING(arg);
823 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000824 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000825 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000826 *p = PyString_AS_STRING(uarg);
Marc-André Lemburg6f15e572001-05-02 17:16:16 +0000827 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000828 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000829 return converterr("string", arg, msgbuf, bufsize);
Thomas Wouters89f507f2006-12-13 04:49:30 +0000830 if ((Py_ssize_t)strlen(*p) != PyString_Size(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000831 return converterr("string without null bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000832 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000833 }
834 break;
835 }
836
Walter Dörwald612344f2007-05-04 19:28:21 +0000837 case 'y': {/* bytes */
838 if (*format == '#') {
839 void **p = (void **)va_arg(*p_va, char **);
840 FETCH_SIZE;
841
842 if (PyBytes_Check(arg)) {
843 *p = PyBytes_AS_STRING(arg);
844 STORE_SIZE(PyBytes_GET_SIZE(arg));
845 }
846 else
847 return converterr("bytes", arg, msgbuf, bufsize);
848 format++;
849 } else {
850 char **p = va_arg(*p_va, char **);
851
852 if (PyBytes_Check(arg))
853 *p = PyBytes_AS_STRING(arg);
854 else
855 return converterr("bytes", arg, msgbuf, bufsize);
856 if ((Py_ssize_t)strlen(*p) != PyBytes_Size(arg))
857 return converterr("bytes without null bytes",
858 arg, msgbuf, bufsize);
859 }
860 break;
861 }
862
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000863 case 'z': {/* string, may be NULL (None) */
864 if (*format == '#') { /* any buffer-like object */
865 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000866 FETCH_SIZE;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000867
868 if (arg == Py_None) {
869 *p = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000870 STORE_SIZE(0);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000871 }
872 else if (PyString_Check(arg)) {
873 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000874 STORE_SIZE(PyString_GET_SIZE(arg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000875 }
876 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000877 uarg = UNICODE_DEFAULT_ENCODING(arg);
878 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000879 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000880 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000881 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000882 STORE_SIZE(PyString_GET_SIZE(uarg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000883 }
884 else { /* any buffer-like object */
885 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000886 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000887 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000888 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000889 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000890 }
891 format++;
892 } else {
893 char **p = va_arg(*p_va, char **);
894
895 if (arg == Py_None)
896 *p = 0;
897 else if (PyString_Check(arg))
Jeremy Hyltona4c8cd72001-10-10 02:51:08 +0000898 *p = PyString_AS_STRING(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000899 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000900 uarg = UNICODE_DEFAULT_ENCODING(arg);
901 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000902 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000903 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000904 *p = PyString_AS_STRING(uarg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000905 }
906 else
907 return converterr("string or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000908 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000909 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000910 FETCH_SIZE;
Thomas Woutersc3547a32006-03-01 21:31:21 +0000911 assert(0); /* XXX redundant with if-case */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000912 if (arg == Py_None)
913 *q = 0;
914 else
915 *q = PyString_Size(arg);
916 format++;
917 }
918 else if (*p != NULL &&
Thomas Wouters89f507f2006-12-13 04:49:30 +0000919 (Py_ssize_t)strlen(*p) != PyString_Size(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000920 return converterr(
921 "string without null bytes or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000922 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000923 }
924 break;
925 }
926
Guido van Rossumfb67be22007-08-29 18:38:11 +0000927 case 'Z': {/* unicode, may be NULL (None) */
928 if (*format == '#') { /* any buffer-like object */
929 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
930 FETCH_SIZE;
931
932 if (arg == Py_None) {
933 *p = 0;
934 STORE_SIZE(0);
935 }
936 else if (PyUnicode_Check(arg)) {
937 *p = PyUnicode_AS_UNICODE(arg);
938 STORE_SIZE(PyUnicode_GET_SIZE(arg));
939 }
940 format++;
941 } else {
942 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
943
944 if (arg == Py_None)
945 *p = 0;
946 else if (PyUnicode_Check(arg))
947 *p = PyUnicode_AS_UNICODE(arg);
948 else
949 return converterr("string or None",
950 arg, msgbuf, bufsize);
951 }
952 break;
953 }
954
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000955 case 'e': {/* encoded string */
956 char **buffer;
957 const char *encoding;
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000958 PyObject *s;
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000959 int recode_strings;
960 Py_ssize_t size;
Guido van Rossumd70539a2007-05-09 23:35:09 +0000961 const char *ptr;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000962
963 /* Get 'e' parameter: the encoding name */
964 encoding = (const char *)va_arg(*p_va, const char *);
965 if (encoding == NULL)
966 encoding = PyUnicode_GetDefaultEncoding();
967
968 /* Get output buffer parameter:
969 's' (recode all objects via Unicode) or
970 't' (only recode non-string objects)
971 */
972 if (*format == 's')
973 recode_strings = 1;
974 else if (*format == 't')
975 recode_strings = 0;
976 else
977 return converterr(
978 "(unknown parser marker combination)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000979 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000980 buffer = (char **)va_arg(*p_va, char **);
981 format++;
982 if (buffer == NULL)
983 return converterr("(buffer is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000984 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000985
986 /* Encode object */
Guido van Rossumd70539a2007-05-09 23:35:09 +0000987 if (!recode_strings &&
988 (PyString_Check(arg) || PyBytes_Check(arg))) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000989 s = arg;
990 Py_INCREF(s);
Guido van Rossumd70539a2007-05-09 23:35:09 +0000991 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
992 return converterr("(AsCharBuffer failed)",
993 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000994 }
995 else {
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000996 PyObject *u;
997
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000998 /* Convert object to Unicode */
999 u = PyUnicode_FromObject(arg);
1000 if (u == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001001 return converterr(
1002 "string or unicode or text buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001003 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001004
1005 /* Encode object; use default error handling */
1006 s = PyUnicode_AsEncodedString(u,
1007 encoding,
1008 NULL);
1009 Py_DECREF(u);
1010 if (s == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001011 return converterr("(encoding failed)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001012 arg, msgbuf, bufsize);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001013 if (!PyBytes_Check(s)) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001014 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001015 return converterr(
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001016 "(encoder failed to return bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001017 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001018 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001019 size = PyBytes_GET_SIZE(s);
1020 ptr = PyBytes_AS_STRING(s);
Guido van Rossumd70539a2007-05-09 23:35:09 +00001021 if (ptr == NULL)
1022 ptr = "";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001023 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001024
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001025 /* Write output; output is guaranteed to be 0-terminated */
1026 if (*format == '#') {
1027 /* Using buffer length parameter '#':
1028
1029 - if *buffer is NULL, a new buffer of the
1030 needed size is allocated and the data
1031 copied into it; *buffer is updated to point
1032 to the new buffer; the caller is
1033 responsible for PyMem_Free()ing it after
1034 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001035
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001036 - if *buffer is not NULL, the data is
1037 copied to *buffer; *buffer_len has to be
1038 set to the size of the buffer on input;
1039 buffer overflow is signalled with an error;
1040 buffer has to provide enough room for the
1041 encoded string plus the trailing 0-byte
1042
1043 - in both cases, *buffer_len is updated to
1044 the size of the buffer /excluding/ the
1045 trailing 0-byte
1046
1047 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001048 FETCH_SIZE;
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001049
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001050 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001051 if (q == NULL && q2 == NULL) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001052 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001053 return converterr(
1054 "(buffer_len is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001055 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001056 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001057 if (*buffer == NULL) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001058 *buffer = PyMem_NEW(char, size + 1);
1059 if (*buffer == NULL) {
1060 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001061 return converterr(
1062 "(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001063 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001064 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001065 if(addcleanup(*buffer, freelist)) {
1066 Py_DECREF(s);
1067 return converterr(
1068 "(cleanup problem)",
1069 arg, msgbuf, bufsize);
1070 }
Fred Drake25871c02000-05-03 15:17:02 +00001071 } else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001072 if (size + 1 > BUFFER_LEN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001073 Py_DECREF(s);
1074 return converterr(
1075 "(buffer overflow)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001076 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001077 }
Fred Drake25871c02000-05-03 15:17:02 +00001078 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001079 memcpy(*buffer, ptr, size+1);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001080 STORE_SIZE(size);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001081 } else {
1082 /* Using a 0-terminated buffer:
1083
1084 - the encoded string has to be 0-terminated
1085 for this variant to work; if it is not, an
1086 error raised
Fred Drake25871c02000-05-03 15:17:02 +00001087
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001088 - a new buffer of the needed size is
1089 allocated and the data copied into it;
1090 *buffer is updated to point to the new
1091 buffer; the caller is responsible for
1092 PyMem_Free()ing it after usage
1093
1094 */
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001095 if ((Py_ssize_t)strlen(ptr) != size) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001096 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001097 return converterr(
1098 "(encoded string without NULL bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001099 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001100 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001101 *buffer = PyMem_NEW(char, size + 1);
1102 if (*buffer == NULL) {
1103 Py_DECREF(s);
1104 return converterr("(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001105 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001106 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001107 if(addcleanup(*buffer, freelist)) {
1108 Py_DECREF(s);
1109 return converterr("(cleanup problem)",
1110 arg, msgbuf, bufsize);
1111 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001112 memcpy(*buffer, ptr, size+1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001113 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001114 Py_DECREF(s);
1115 break;
1116 }
1117
1118 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1119 if (*format == '#') { /* any buffer-like object */
1120 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001121 FETCH_SIZE;
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001122 if (PyUnicode_Check(arg)) {
1123 *p = PyUnicode_AS_UNICODE(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001124 STORE_SIZE(PyUnicode_GET_SIZE(arg));
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001125 }
1126 else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001127 return converterr("cannot convert raw buffers",
1128 arg, msgbuf, bufsize);
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001129 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001130 format++;
1131 } else {
1132 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossume826ef02000-03-10 23:02:17 +00001133 if (PyUnicode_Check(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001134 *p = PyUnicode_AS_UNICODE(arg);
1135 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001136 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001137 }
1138 break;
1139 }
1140
1141 case 'S': { /* string object */
1142 PyObject **p = va_arg(*p_va, PyObject **);
Guido van Rossum572dbf82007-04-27 23:53:51 +00001143 if (PyString_Check(arg) || PyUnicode_Check(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001144 *p = arg;
1145 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001146 return converterr("string", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001147 break;
1148 }
Guido van Rossum617dbc42007-05-07 23:57:08 +00001149
1150 case 'Y': { /* bytes object */
1151 PyObject **p = va_arg(*p_va, PyObject **);
1152 if (PyBytes_Check(arg))
1153 *p = arg;
1154 else
1155 return converterr("bytes", arg, msgbuf, bufsize);
1156 break;
1157 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001158
1159 case 'U': { /* Unicode object */
1160 PyObject **p = va_arg(*p_va, PyObject **);
1161 if (PyUnicode_Check(arg))
1162 *p = arg;
1163 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001164 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001165 break;
1166 }
1167
1168 case 'O': { /* object */
1169 PyTypeObject *type;
1170 PyObject **p;
1171 if (*format == '!') {
1172 type = va_arg(*p_va, PyTypeObject*);
1173 p = va_arg(*p_va, PyObject **);
1174 format++;
Guido van Rossumcbfc8552001-08-28 16:37:51 +00001175 if (PyType_IsSubtype(arg->ob_type, type))
Guido van Rossume826ef02000-03-10 23:02:17 +00001176 *p = arg;
1177 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001178 return converterr(type->tp_name, arg, msgbuf, bufsize);
Guido van Rossumfccfe891998-05-15 22:04:07 +00001179
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001180 }
1181 else if (*format == '?') {
1182 inquiry pred = va_arg(*p_va, inquiry);
1183 p = va_arg(*p_va, PyObject **);
1184 format++;
1185 if ((*pred)(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001186 *p = arg;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001187 else
1188 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001189 arg, msgbuf, bufsize);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001190
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001191 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001192 else if (*format == '&') {
1193 typedef int (*converter)(PyObject *, void *);
1194 converter convert = va_arg(*p_va, converter);
1195 void *addr = va_arg(*p_va, void *);
1196 format++;
1197 if (! (*convert)(arg, addr))
1198 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001199 arg, msgbuf, bufsize);
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001200 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001201 else {
1202 p = va_arg(*p_va, PyObject **);
1203 *p = arg;
1204 }
1205 break;
1206 }
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001207
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001208
1209 case 'w': { /* memory buffer, read-write access */
1210 void **p = va_arg(*p_va, void **);
1211 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1212 int count;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001213 int temp=-1;
1214 PyBuffer view;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001215
1216 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001217 pb->bf_getbuffer == NULL ||
1218 ((temp = (*pb->bf_getbuffer)(arg, &view,
1219 PyBUF_SIMPLE)) != 0) ||
1220 view.readonly == 1) {
1221 if (temp==0 && pb->bf_releasebuffer != NULL) {
1222 (*pb->bf_releasebuffer)(arg, &view);
1223 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001224 return converterr("single-segment read-write buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001225 arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001226 }
1227
1228 if ((count = view.len) < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001229 return converterr("(unspecified)", arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001230 *p = view.buf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001231 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001232 FETCH_SIZE;
1233 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001234 format++;
1235 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001236 if (pb->bf_releasebuffer != NULL)
1237 (*pb->bf_releasebuffer)(arg, &view);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001238 break;
1239 }
1240
1241 case 't': { /* 8-bit character buffer, read-only access */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001242 char **p = va_arg(*p_va, char **);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001243 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001244 int count;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001245 PyBuffer view;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001246
1247 if (*format++ != '#')
1248 return converterr(
1249 "invalid use of 't' format character",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001250 arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001251 if (pb == NULL || pb->bf_getbuffer == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001252 return converterr(
1253 "string or read-only character buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001254 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001255
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001256 if ((*pb->bf_getbuffer)(arg, &view, PyBUF_CHARACTER) != 0)
1257 return converterr("string or single-segment read-only buffer",
1258 arg, msgbuf, bufsize);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001259
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001260 count = view.len;
1261 *p = view.buf;
1262 /* XXX : shouldn't really release buffer, but it should be O.K.
1263 */
1264 if (pb->bf_releasebuffer != NULL)
1265 (*pb->bf_releasebuffer)(arg, &view);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001266 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001267 return converterr("(unspecified)", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001268 {
1269 FETCH_SIZE;
1270 STORE_SIZE(count);
1271 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001272 break;
1273 }
1274
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001275 default:
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001276 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001277
1278 }
1279
1280 *p_format = format;
1281 return NULL;
1282}
Guido van Rossumaa354651996-08-19 19:32:04 +00001283
Martin v. Löwis18e16552006-02-15 17:27:45 +00001284static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001285convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001286{
1287 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001288 Py_ssize_t count;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001289 PyBuffer view;
1290
1291 *errmsg = NULL;
1292 *p = NULL;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001293 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001294 pb->bf_getbuffer == NULL) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001295 *errmsg = "string or read-only buffer";
1296 return -1;
1297 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001298
1299 if ((*pb->bf_getbuffer)(arg, &view, PyBUF_SIMPLE) != 0) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001300 *errmsg = "string or single-segment read-only buffer";
1301 return -1;
1302 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001303 count = view.len;
1304 *p = view.buf;
1305 if (pb->bf_releasebuffer != NULL)
1306 (*pb->bf_releasebuffer)(arg, &view);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001307 return count;
1308}
Guido van Rossumaa354651996-08-19 19:32:04 +00001309
1310/* Support for keyword arguments donated by
1311 Geoff Philbrick <philbric@delphi.hks.com> */
1312
Tim Petersf8cd3e82001-10-27 04:26:57 +00001313/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001314int
1315PyArg_ParseTupleAndKeywords(PyObject *args,
1316 PyObject *keywords,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001317 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001318 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001319{
1320 int retval;
1321 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001322
1323 if ((args == NULL || !PyTuple_Check(args)) ||
1324 (keywords != NULL && !PyDict_Check(keywords)) ||
1325 format == NULL ||
1326 kwlist == NULL)
1327 {
1328 PyErr_BadInternalCall();
Tim Petersf8cd3e82001-10-27 04:26:57 +00001329 return 0;
Tim Peters45772cd2001-10-27 03:58:40 +00001330 }
1331
Guido van Rossumaa354651996-08-19 19:32:04 +00001332 va_start(va, kwlist);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001333 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1334 va_end(va);
1335 return retval;
1336}
1337
1338int
1339_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1340 PyObject *keywords,
1341 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001342 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001343{
1344 int retval;
1345 va_list va;
1346
1347 if ((args == NULL || !PyTuple_Check(args)) ||
1348 (keywords != NULL && !PyDict_Check(keywords)) ||
1349 format == NULL ||
1350 kwlist == NULL)
1351 {
1352 PyErr_BadInternalCall();
1353 return 0;
1354 }
1355
1356 va_start(va, kwlist);
1357 retval = vgetargskeywords(args, keywords, format,
1358 kwlist, &va, FLAG_SIZE_T);
Guido van Rossumaa354651996-08-19 19:32:04 +00001359 va_end(va);
1360 return retval;
1361}
1362
1363
Brett Cannon711e7d92004-07-10 22:20:32 +00001364int
1365PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001366 PyObject *keywords,
1367 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001368 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001369{
1370 int retval;
1371 va_list lva;
1372
1373 if ((args == NULL || !PyTuple_Check(args)) ||
1374 (keywords != NULL && !PyDict_Check(keywords)) ||
1375 format == NULL ||
1376 kwlist == NULL)
1377 {
1378 PyErr_BadInternalCall();
1379 return 0;
1380 }
1381
1382#ifdef VA_LIST_IS_ARRAY
1383 memcpy(lva, va, sizeof(va_list));
1384#else
1385#ifdef __va_copy
1386 __va_copy(lva, va);
1387#else
1388 lva = va;
1389#endif
1390#endif
1391
Martin v. Löwis18e16552006-02-15 17:27:45 +00001392 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1393 return retval;
1394}
1395
1396int
1397_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1398 PyObject *keywords,
1399 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001400 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001401{
1402 int retval;
1403 va_list lva;
1404
1405 if ((args == NULL || !PyTuple_Check(args)) ||
1406 (keywords != NULL && !PyDict_Check(keywords)) ||
1407 format == NULL ||
1408 kwlist == NULL)
1409 {
1410 PyErr_BadInternalCall();
1411 return 0;
1412 }
1413
1414#ifdef VA_LIST_IS_ARRAY
1415 memcpy(lva, va, sizeof(va_list));
1416#else
1417#ifdef __va_copy
1418 __va_copy(lva, va);
1419#else
1420 lva = va;
1421#endif
1422#endif
1423
1424 retval = vgetargskeywords(args, keywords, format,
1425 kwlist, &lva, FLAG_SIZE_T);
Brett Cannon711e7d92004-07-10 22:20:32 +00001426 return retval;
1427}
1428
1429
Guido van Rossumaa354651996-08-19 19:32:04 +00001430static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001431vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001432 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001433{
Tim Petersdc5eff92001-10-27 06:53:00 +00001434 char msgbuf[512];
Guido van Rossumaa354651996-08-19 19:32:04 +00001435 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001436 const char *fname, *message;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001437 int min, max;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001438 const char *formatsave;
Tim Petersb639d492001-10-27 07:00:56 +00001439 int i, len, nargs, nkeywords;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001440 const char *msg;
1441 char **p;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001442 PyObject *freelist = NULL;
Tim Petersf4331c12001-10-27 00:17:34 +00001443
Tim Peters45772cd2001-10-27 03:58:40 +00001444 assert(args != NULL && PyTuple_Check(args));
1445 assert(keywords == NULL || PyDict_Check(keywords));
1446 assert(format != NULL);
1447 assert(kwlist != NULL);
1448 assert(p_va != NULL);
1449
Tim Petersf8cd3e82001-10-27 04:26:57 +00001450 /* Search the format:
1451 message <- error msg, if any (else NULL).
Tim Peterscffed4b2001-11-29 03:26:37 +00001452 fname <- routine name, if any (else NULL).
Tim Petersf8cd3e82001-10-27 04:26:57 +00001453 min <- # of required arguments, or -1 if all are required.
1454 max <- most arguments (required + optional).
Tim Peters62d48e12001-10-27 06:42:16 +00001455 Check that kwlist has a non-NULL entry for each arg.
Tim Petersf8cd3e82001-10-27 04:26:57 +00001456 Raise error if a tuple arg spec is found.
1457 */
1458 fname = message = NULL;
Tim Peters6fb26352001-10-27 04:38:11 +00001459 formatsave = format;
Tim Peters62d48e12001-10-27 06:42:16 +00001460 p = kwlist;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001461 min = -1;
1462 max = 0;
1463 while ((i = *format++) != '\0') {
Neal Norwitz30b5c5d2005-12-19 06:05:18 +00001464 if (isalpha(Py_CHARMASK(i)) && i != 'e') {
Tim Petersf8cd3e82001-10-27 04:26:57 +00001465 max++;
Tim Peters62d48e12001-10-27 06:42:16 +00001466 if (*p == NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001467 PyErr_SetString(PyExc_RuntimeError,
1468 "more argument specifiers than "
1469 "keyword list entries");
Tim Peters62d48e12001-10-27 06:42:16 +00001470 return 0;
1471 }
1472 p++;
1473 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001474 else if (i == '|')
1475 min = max;
1476 else if (i == ':') {
1477 fname = format;
1478 break;
1479 }
1480 else if (i == ';') {
1481 message = format;
1482 break;
1483 }
1484 else if (i == '(') {
Tim Peterscffed4b2001-11-29 03:26:37 +00001485 PyErr_SetString(PyExc_RuntimeError,
1486 "tuple found in format when using keyword "
1487 "arguments");
Guido van Rossumaa354651996-08-19 19:32:04 +00001488 return 0;
1489 }
Tim Peters62d48e12001-10-27 06:42:16 +00001490 }
1491 format = formatsave;
1492 if (*p != NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001493 PyErr_SetString(PyExc_RuntimeError,
1494 "more keyword list entries than "
1495 "argument specifiers");
Tim Peters62d48e12001-10-27 06:42:16 +00001496 return 0;
1497 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001498 if (min < 0) {
1499 /* All arguments are required. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001500 min = max;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001501 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001502
Tim Peters6fb26352001-10-27 04:38:11 +00001503 nargs = PyTuple_GET_SIZE(args);
Tim Petersb0872fc2001-10-27 04:45:34 +00001504 nkeywords = keywords == NULL ? 0 : PyDict_Size(keywords);
Tim Petersf8cd3e82001-10-27 04:26:57 +00001505
Guido van Rossumaa354651996-08-19 19:32:04 +00001506 /* make sure there are no duplicate values for an argument;
1507 its not clear when to use the term "keyword argument vs.
1508 keyword parameter in messages */
Tim Petersb054be42001-10-27 05:07:41 +00001509 if (nkeywords > 0) {
Tim Peters6fb26352001-10-27 04:38:11 +00001510 for (i = 0; i < nargs; i++) {
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001511 const char *thiskw = kwlist[i];
Tim Petersa9f47392001-10-27 00:46:09 +00001512 if (thiskw == NULL)
1513 break;
Tim Peters077f5742001-10-27 05:50:39 +00001514 if (PyDict_GetItemString(keywords, thiskw)) {
Tim Petersb054be42001-10-27 05:07:41 +00001515 PyErr_Format(PyExc_TypeError,
1516 "keyword parameter '%s' was given "
1517 "by position and by name",
Tim Petersa9f47392001-10-27 00:46:09 +00001518 thiskw);
Guido van Rossumaa354651996-08-19 19:32:04 +00001519 return 0;
1520 }
Tim Peters0af49162001-10-27 06:14:32 +00001521 else if (PyErr_Occurred())
1522 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001523 }
1524 }
Tim Peters61dde632001-10-27 05:30:17 +00001525
Guido van Rossumaa354651996-08-19 19:32:04 +00001526 /* required arguments missing from args can be supplied by keyword
Georg Brandld7048172006-01-20 17:53:27 +00001527 arguments; set len to the number of positional arguments, and,
Tim Peters62d48e12001-10-27 06:42:16 +00001528 if that's less than the minimum required, add in the number of
1529 required arguments that are supplied by keywords */
Tim Peters6fb26352001-10-27 04:38:11 +00001530 len = nargs;
Tim Peters62d48e12001-10-27 06:42:16 +00001531 if (nkeywords > 0 && nargs < min) {
Tim Peters6fb26352001-10-27 04:38:11 +00001532 for (i = nargs; i < min; i++) {
Tim Peters077f5742001-10-27 05:50:39 +00001533 if (PyDict_GetItemString(keywords, kwlist[i]))
Guido van Rossumaa354651996-08-19 19:32:04 +00001534 len++;
Tim Peters0af49162001-10-27 06:14:32 +00001535 else if (PyErr_Occurred())
1536 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001537 }
1538 }
Tim Peters0af49162001-10-27 06:14:32 +00001539
Guido van Rossumaa354651996-08-19 19:32:04 +00001540 /* make sure we got an acceptable number of arguments; the message
1541 is a little confusing with keywords since keyword arguments
1542 which are supplied, but don't match the required arguments
Michael W. Hudson5253c302005-03-30 16:41:55 +00001543 are not included in the "%d given" part of the message
1544 XXX and this isn't a bug!? */
Guido van Rossumaa354651996-08-19 19:32:04 +00001545 if (len < min || max < len) {
1546 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +00001547 PyOS_snprintf(msgbuf, sizeof(msgbuf),
1548 "%.200s%s takes %s %d argument%s "
1549 "(%d given)",
1550 fname==NULL ? "function" : fname,
1551 fname==NULL ? "" : "()",
1552 min==max ? "exactly"
1553 : len < min ? "at least" : "at most",
1554 len < min ? min : max,
1555 (len < min ? min : max) == 1 ? "" : "s",
1556 len);
Guido van Rossumaa354651996-08-19 19:32:04 +00001557 message = msgbuf;
1558 }
1559 PyErr_SetString(PyExc_TypeError, message);
1560 return 0;
1561 }
Tim Petersc2f01122001-10-27 07:25:06 +00001562
1563 /* convert the positional arguments */
Tim Peters6fb26352001-10-27 04:38:11 +00001564 for (i = 0; i < nargs; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001565 if (*format == '|')
1566 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +00001567 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001568 flags, levels, msgbuf, sizeof(msgbuf),
1569 &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001570 if (msg) {
1571 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001572 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001573 }
1574 }
1575
Tim Petersc2f01122001-10-27 07:25:06 +00001576 /* handle no keyword parameters in call */
Tim Petersb054be42001-10-27 05:07:41 +00001577 if (nkeywords == 0)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001578 return cleanreturn(1, freelist);
Tim Petersb054be42001-10-27 05:07:41 +00001579
Guido van Rossumaa354651996-08-19 19:32:04 +00001580 /* convert the keyword arguments; this uses the format
1581 string where it was left after processing args */
Tim Petersb639d492001-10-27 07:00:56 +00001582 for (i = nargs; i < max; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001583 PyObject *item;
Guido van Rossumaa354651996-08-19 19:32:04 +00001584 if (*format == '|')
1585 format++;
Tim Peters077f5742001-10-27 05:50:39 +00001586 item = PyDict_GetItemString(keywords, kwlist[i]);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001587 if (item != NULL) {
Tim Peters077f5742001-10-27 05:50:39 +00001588 Py_INCREF(item);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001589 msg = convertitem(item, &format, p_va, flags, levels,
1590 msgbuf, sizeof(msgbuf), &freelist);
Tim Peters077f5742001-10-27 05:50:39 +00001591 Py_DECREF(item);
Guido van Rossumaa354651996-08-19 19:32:04 +00001592 if (msg) {
1593 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001594 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001595 }
Tim Petersc2f01122001-10-27 07:25:06 +00001596 --nkeywords;
1597 if (nkeywords == 0)
1598 break;
Guido van Rossumaa354651996-08-19 19:32:04 +00001599 }
Tim Peters0af49162001-10-27 06:14:32 +00001600 else if (PyErr_Occurred())
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001601 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001602 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001603 msg = skipitem(&format, p_va, flags);
Guido van Rossumaa354651996-08-19 19:32:04 +00001604 if (msg) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001605 levels[0] = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001606 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001607 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001608 }
1609 }
1610 }
Tim Petersb054be42001-10-27 05:07:41 +00001611
Guido van Rossumaa354651996-08-19 19:32:04 +00001612 /* make sure there are no extraneous keyword arguments */
Tim Petersc2f01122001-10-27 07:25:06 +00001613 if (nkeywords > 0) {
1614 PyObject *key, *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001615 Py_ssize_t pos = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001616 while (PyDict_Next(keywords, &pos, &key, &value)) {
Tim Petersc2f01122001-10-27 07:25:06 +00001617 int match = 0;
Guido van Rossum55474762002-04-04 16:22:30 +00001618 char *ks;
Guido van Rossum572dbf82007-04-27 23:53:51 +00001619 if (!PyString_Check(key) && !PyUnicode_Check(key)) {
Guido van Rossum55474762002-04-04 16:22:30 +00001620 PyErr_SetString(PyExc_TypeError,
1621 "keywords must be strings");
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001622 return cleanreturn(0, freelist);
Guido van Rossum55474762002-04-04 16:22:30 +00001623 }
1624 ks = PyString_AsString(key);
Tim Petersb639d492001-10-27 07:00:56 +00001625 for (i = 0; i < max; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001626 if (!strcmp(ks, kwlist[i])) {
1627 match = 1;
1628 break;
1629 }
1630 }
1631 if (!match) {
Tim Petersc2f01122001-10-27 07:25:06 +00001632 PyErr_Format(PyExc_TypeError,
1633 "'%s' is an invalid keyword "
1634 "argument for this function",
1635 ks);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001636 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001637 }
1638 }
1639 }
Tim Petersc2f01122001-10-27 07:25:06 +00001640
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001641 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001642}
1643
1644
1645static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001646skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001647{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001648 const char *format = *p_format;
Guido van Rossumaa354651996-08-19 19:32:04 +00001649 char c = *format++;
1650
1651 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001652
1653 /* simple codes
1654 * The individual types (second arg of va_arg) are irrelevant */
1655
Guido van Rossumaa354651996-08-19 19:32:04 +00001656 case 'b': /* byte -- very short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001657 case 'B': /* byte as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001658 case 'h': /* short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001659 case 'H': /* short int as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001660 case 'i': /* int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001661 case 'I': /* int sized bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001662 case 'l': /* long int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001663 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001664#ifdef HAVE_LONG_LONG
Georg Brandl6dd14612005-09-14 19:29:53 +00001665 case 'L': /* PY_LONG_LONG */
1666 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001667#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001668 case 'f': /* float */
Guido van Rossumaa354651996-08-19 19:32:04 +00001669 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001670#ifndef WITHOUT_COMPLEX
1671 case 'D': /* complex double */
Georg Brandl6dd14612005-09-14 19:29:53 +00001672#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001673 case 'c': /* char */
1674 {
Georg Brandl6dd14612005-09-14 19:29:53 +00001675 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001676 break;
1677 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001678
1679 case 'n': /* Py_ssize_t */
1680 {
1681 (void) va_arg(*p_va, Py_ssize_t *);
1682 break;
1683 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001684
Georg Brandl6dd14612005-09-14 19:29:53 +00001685 /* string codes */
1686
1687 case 'e': /* string with encoding */
1688 {
1689 (void) va_arg(*p_va, const char *);
1690 if (!(*format == 's' || *format == 't'))
1691 /* after 'e', only 's' and 't' is allowed */
1692 goto err;
1693 format++;
1694 /* explicit fallthrough to string cases */
1695 }
1696
Guido van Rossumaa354651996-08-19 19:32:04 +00001697 case 's': /* string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001698 case 'z': /* string or None */
Walter Dörwald612344f2007-05-04 19:28:21 +00001699 case 'y': /* bytes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001700 case 'u': /* unicode string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001701 case 't': /* buffer, read-only */
1702 case 'w': /* buffer, read-write */
Guido van Rossumaa354651996-08-19 19:32:04 +00001703 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001704 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001705 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001706 if (flags & FLAG_SIZE_T)
1707 (void) va_arg(*p_va, Py_ssize_t *);
1708 else
1709 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001710 format++;
1711 }
1712 break;
1713 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001714
1715 /* object codes */
1716
Guido van Rossumaa354651996-08-19 19:32:04 +00001717 case 'S': /* string object */
Guido van Rossum617dbc42007-05-07 23:57:08 +00001718 case 'Y': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001719 case 'U': /* unicode string object */
Guido van Rossumaa354651996-08-19 19:32:04 +00001720 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001721 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001722 break;
1723 }
1724
1725 case 'O': /* object */
1726 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001727 if (*format == '!') {
1728 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001729 (void) va_arg(*p_va, PyTypeObject*);
1730 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001731 }
1732#if 0
1733/* I don't know what this is for */
1734 else if (*format == '?') {
1735 inquiry pred = va_arg(*p_va, inquiry);
1736 format++;
1737 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001738 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001739 }
1740 }
1741#endif
1742 else if (*format == '&') {
Tim Petersdbd9ba62000-07-09 03:09:57 +00001743 typedef int (*converter)(PyObject *, void *);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001744 (void) va_arg(*p_va, converter);
1745 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001746 format++;
1747 }
1748 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001749 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001750 }
1751 break;
1752 }
1753
1754 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001755err:
Guido van Rossumaa354651996-08-19 19:32:04 +00001756 return "impossible<bad format char>";
1757
1758 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001759
1760 /* The "(...)" format code for tuples is not handled here because
1761 * it is not allowed with keyword args. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001762
1763 *p_format = format;
1764 return NULL;
1765}
Fred Drakee4616e62001-10-23 21:09:29 +00001766
1767
1768int
Martin v. Löwis76246742006-03-01 04:06:10 +00001769PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001770{
Martin v. Löwis76246742006-03-01 04:06:10 +00001771 Py_ssize_t i, l;
Fred Drakee4616e62001-10-23 21:09:29 +00001772 PyObject **o;
1773 va_list vargs;
1774
1775#ifdef HAVE_STDARG_PROTOTYPES
1776 va_start(vargs, max);
1777#else
1778 va_start(vargs);
1779#endif
1780
1781 assert(min >= 0);
1782 assert(min <= max);
1783 if (!PyTuple_Check(args)) {
1784 PyErr_SetString(PyExc_SystemError,
1785 "PyArg_UnpackTuple() argument list is not a tuple");
1786 return 0;
1787 }
1788 l = PyTuple_GET_SIZE(args);
1789 if (l < min) {
1790 if (name != NULL)
1791 PyErr_Format(
1792 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001793 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001794 name, (min == max ? "" : "at least "), min, l);
1795 else
1796 PyErr_Format(
1797 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001798 "unpacked tuple should have %s%zd elements,"
1799 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001800 (min == max ? "" : "at least "), min, l);
1801 va_end(vargs);
1802 return 0;
1803 }
1804 if (l > max) {
1805 if (name != NULL)
1806 PyErr_Format(
1807 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001808 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001809 name, (min == max ? "" : "at most "), max, l);
1810 else
1811 PyErr_Format(
1812 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001813 "unpacked tuple should have %s%zd elements,"
1814 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001815 (min == max ? "" : "at most "), max, l);
1816 va_end(vargs);
1817 return 0;
1818 }
1819 for (i = 0; i < l; i++) {
1820 o = va_arg(vargs, PyObject **);
1821 *o = PyTuple_GET_ITEM(args, i);
1822 }
1823 va_end(vargs);
1824 return 1;
1825}
Georg Brandl02c42872005-08-26 06:42:30 +00001826
1827
1828/* For type constructors that don't take keyword args
1829 *
1830 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001831 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001832 */
1833int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001834_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001835{
1836 if (kw == NULL)
1837 return 1;
1838 if (!PyDict_CheckExact(kw)) {
1839 PyErr_BadInternalCall();
1840 return 0;
1841 }
1842 if (PyDict_Size(kw) == 0)
1843 return 1;
1844
1845 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1846 funcname);
1847 return 0;
1848}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001849#ifdef __cplusplus
1850};
1851#endif