blob: 2a02a8904e59f794068826abbd5a96b4dd947267 [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 {
668 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
669 Py_ssize_t ival;
670 if (float_argument_error(arg))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000671 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000672 ival = PyInt_AsSsize_t(arg);
673 if (ival == -1 && PyErr_Occurred())
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000674 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000675 *p = ival;
676 break;
677 }
678#endif
679 /* Fall through from 'n' to 'l' if Py_ssize_t is int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000680 case 'l': {/* long int */
681 long *p = va_arg(*p_va, long *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000682 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000683 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000684 return converterr("integer<l>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000685 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000686 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000687 return converterr("integer<l>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000688 else
689 *p = ival;
690 break;
691 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000692
693 case 'k': { /* long sized bitfield */
694 unsigned long *p = va_arg(*p_va, unsigned long *);
695 unsigned long ival;
696 if (PyInt_Check(arg))
697 ival = PyInt_AsUnsignedLongMask(arg);
698 else if (PyLong_Check(arg))
699 ival = PyLong_AsUnsignedLongMask(arg);
700 else
701 return converterr("integer<k>", arg, msgbuf, bufsize);
702 *p = ival;
703 break;
704 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000705
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000706#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000707 case 'L': {/* PY_LONG_LONG */
708 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
709 PY_LONG_LONG ival = PyLong_AsLongLong( arg );
710 if( ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000711 return converterr("long<L>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000712 } else {
713 *p = ival;
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000714 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000715 break;
716 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000717
718 case 'K': { /* long long sized bitfield */
719 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
720 unsigned PY_LONG_LONG ival;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000721 if (PyLong_Check(arg))
Thomas Hellera4ea6032003-04-17 18:55:45 +0000722 ival = PyLong_AsUnsignedLongLongMask(arg);
723 else
724 return converterr("integer<K>", arg, msgbuf, bufsize);
725 *p = ival;
726 break;
727 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000728#endif
729
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000730 case 'f': {/* float */
731 float *p = va_arg(*p_va, float *);
732 double dval = PyFloat_AsDouble(arg);
733 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000734 return converterr("float<f>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000735 else
736 *p = (float) dval;
737 break;
738 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000739
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000740 case 'd': {/* double */
741 double *p = va_arg(*p_va, double *);
742 double dval = PyFloat_AsDouble(arg);
743 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000744 return converterr("float<d>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000745 else
746 *p = dval;
747 break;
748 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000749
Guido van Rossum530956d1996-07-21 02:27:43 +0000750#ifndef WITHOUT_COMPLEX
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000751 case 'D': {/* complex double */
752 Py_complex *p = va_arg(*p_va, Py_complex *);
753 Py_complex cval;
754 cval = PyComplex_AsCComplex(arg);
755 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000756 return converterr("complex<D>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000757 else
758 *p = cval;
759 break;
760 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000761#endif /* WITHOUT_COMPLEX */
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000762
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000763 case 'c': {/* char */
764 char *p = va_arg(*p_va, char *);
765 if (PyString_Check(arg) && PyString_Size(arg) == 1)
Jeremy Hylton0407aea2001-10-10 02:51:57 +0000766 *p = PyString_AS_STRING(arg)[0];
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000767 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000768 return converterr("char", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000769 break;
770 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000771
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000772 case 's': {/* string */
773 if (*format == '#') {
774 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000775 FETCH_SIZE;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000776
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000777 if (PyString_Check(arg)) {
778 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000779 STORE_SIZE(PyString_GET_SIZE(arg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000780 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000781 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000782 uarg = UNICODE_DEFAULT_ENCODING(arg);
783 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000784 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000785 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000786 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000787 STORE_SIZE(PyString_GET_SIZE(uarg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000788 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000789 else { /* any buffer-like object */
790 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000791 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000792 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000793 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000794 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000795 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000796 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000797 } else {
798 char **p = va_arg(*p_va, char **);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000799
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000800 if (PyString_Check(arg))
801 *p = PyString_AS_STRING(arg);
802 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000803 uarg = UNICODE_DEFAULT_ENCODING(arg);
804 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000805 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000806 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000807 *p = PyString_AS_STRING(uarg);
Marc-André Lemburg6f15e572001-05-02 17:16:16 +0000808 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000809 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000810 return converterr("string", arg, msgbuf, bufsize);
Thomas Wouters89f507f2006-12-13 04:49:30 +0000811 if ((Py_ssize_t)strlen(*p) != PyString_Size(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000812 return converterr("string without null bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000813 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000814 }
815 break;
816 }
817
818 case 'z': {/* string, may be NULL (None) */
819 if (*format == '#') { /* any buffer-like object */
820 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000821 FETCH_SIZE;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000822
823 if (arg == Py_None) {
824 *p = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000825 STORE_SIZE(0);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000826 }
827 else if (PyString_Check(arg)) {
828 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000829 STORE_SIZE(PyString_GET_SIZE(arg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000830 }
831 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000832 uarg = UNICODE_DEFAULT_ENCODING(arg);
833 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000834 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000835 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000836 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000837 STORE_SIZE(PyString_GET_SIZE(uarg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000838 }
839 else { /* any buffer-like object */
840 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000841 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000842 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000843 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000844 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000845 }
846 format++;
847 } else {
848 char **p = va_arg(*p_va, char **);
849
850 if (arg == Py_None)
851 *p = 0;
852 else if (PyString_Check(arg))
Jeremy Hyltona4c8cd72001-10-10 02:51:08 +0000853 *p = PyString_AS_STRING(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000854 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000855 uarg = UNICODE_DEFAULT_ENCODING(arg);
856 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000857 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000858 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000859 *p = PyString_AS_STRING(uarg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000860 }
861 else
862 return converterr("string or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000863 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000864 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000865 FETCH_SIZE;
Thomas Woutersc3547a32006-03-01 21:31:21 +0000866 assert(0); /* XXX redundant with if-case */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000867 if (arg == Py_None)
868 *q = 0;
869 else
870 *q = PyString_Size(arg);
871 format++;
872 }
873 else if (*p != NULL &&
Thomas Wouters89f507f2006-12-13 04:49:30 +0000874 (Py_ssize_t)strlen(*p) != PyString_Size(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000875 return converterr(
876 "string without null bytes or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000877 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000878 }
879 break;
880 }
881
882 case 'e': {/* encoded string */
883 char **buffer;
884 const char *encoding;
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000885 PyObject *s;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000886 int size, recode_strings;
887
888 /* Get 'e' parameter: the encoding name */
889 encoding = (const char *)va_arg(*p_va, const char *);
890 if (encoding == NULL)
891 encoding = PyUnicode_GetDefaultEncoding();
892
893 /* Get output buffer parameter:
894 's' (recode all objects via Unicode) or
895 't' (only recode non-string objects)
896 */
897 if (*format == 's')
898 recode_strings = 1;
899 else if (*format == 't')
900 recode_strings = 0;
901 else
902 return converterr(
903 "(unknown parser marker combination)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000904 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000905 buffer = (char **)va_arg(*p_va, char **);
906 format++;
907 if (buffer == NULL)
908 return converterr("(buffer is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000909 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000910
911 /* Encode object */
912 if (!recode_strings && PyString_Check(arg)) {
913 s = arg;
914 Py_INCREF(s);
915 }
916 else {
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000917 PyObject *u;
918
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000919 /* Convert object to Unicode */
920 u = PyUnicode_FromObject(arg);
921 if (u == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000922 return converterr(
923 "string or unicode or text buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000924 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000925
926 /* Encode object; use default error handling */
927 s = PyUnicode_AsEncodedString(u,
928 encoding,
929 NULL);
930 Py_DECREF(u);
931 if (s == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000932 return converterr("(encoding failed)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000933 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000934 if (!PyString_Check(s)) {
935 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000936 return converterr(
937 "(encoder failed to return a string)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000938 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000939 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000940 }
941 size = PyString_GET_SIZE(s);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000942
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000943 /* Write output; output is guaranteed to be 0-terminated */
944 if (*format == '#') {
945 /* Using buffer length parameter '#':
946
947 - if *buffer is NULL, a new buffer of the
948 needed size is allocated and the data
949 copied into it; *buffer is updated to point
950 to the new buffer; the caller is
951 responsible for PyMem_Free()ing it after
952 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000953
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000954 - if *buffer is not NULL, the data is
955 copied to *buffer; *buffer_len has to be
956 set to the size of the buffer on input;
957 buffer overflow is signalled with an error;
958 buffer has to provide enough room for the
959 encoded string plus the trailing 0-byte
960
961 - in both cases, *buffer_len is updated to
962 the size of the buffer /excluding/ the
963 trailing 0-byte
964
965 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000966 FETCH_SIZE;
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000967
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000968 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000969 if (q == NULL && q2 == NULL) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000970 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000971 return converterr(
972 "(buffer_len is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000973 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000974 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000975 if (*buffer == NULL) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000976 *buffer = PyMem_NEW(char, size + 1);
977 if (*buffer == NULL) {
978 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000979 return converterr(
980 "(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000981 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000982 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000983 if(addcleanup(*buffer, freelist)) {
984 Py_DECREF(s);
985 return converterr(
986 "(cleanup problem)",
987 arg, msgbuf, bufsize);
988 }
Fred Drake25871c02000-05-03 15:17:02 +0000989 } else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000990 if (size + 1 > BUFFER_LEN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000991 Py_DECREF(s);
992 return converterr(
993 "(buffer overflow)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000994 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000995 }
Fred Drake25871c02000-05-03 15:17:02 +0000996 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000997 memcpy(*buffer,
998 PyString_AS_STRING(s),
999 size + 1);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001000 STORE_SIZE(size);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001001 } else {
1002 /* Using a 0-terminated buffer:
1003
1004 - the encoded string has to be 0-terminated
1005 for this variant to work; if it is not, an
1006 error raised
Fred Drake25871c02000-05-03 15:17:02 +00001007
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001008 - a new buffer of the needed size is
1009 allocated and the data copied into it;
1010 *buffer is updated to point to the new
1011 buffer; the caller is responsible for
1012 PyMem_Free()ing it after usage
1013
1014 */
Thomas Wouters89f507f2006-12-13 04:49:30 +00001015 if ((Py_ssize_t)strlen(PyString_AS_STRING(s))
1016 != size) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001017 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001018 return converterr(
1019 "(encoded string without NULL bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001020 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001021 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001022 *buffer = PyMem_NEW(char, size + 1);
1023 if (*buffer == NULL) {
1024 Py_DECREF(s);
1025 return converterr("(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001026 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001027 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001028 if(addcleanup(*buffer, freelist)) {
1029 Py_DECREF(s);
1030 return converterr("(cleanup problem)",
1031 arg, msgbuf, bufsize);
1032 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001033 memcpy(*buffer,
1034 PyString_AS_STRING(s),
1035 size + 1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001036 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001037 Py_DECREF(s);
1038 break;
1039 }
1040
1041 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1042 if (*format == '#') { /* any buffer-like object */
1043 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001044 FETCH_SIZE;
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001045 if (PyUnicode_Check(arg)) {
1046 *p = PyUnicode_AS_UNICODE(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001047 STORE_SIZE(PyUnicode_GET_SIZE(arg));
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001048 }
1049 else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001050 return converterr("cannot convert raw buffers",
1051 arg, msgbuf, bufsize);
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001052 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001053 format++;
1054 } else {
1055 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossume826ef02000-03-10 23:02:17 +00001056 if (PyUnicode_Check(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001057 *p = PyUnicode_AS_UNICODE(arg);
1058 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001059 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001060 }
1061 break;
1062 }
1063
1064 case 'S': { /* string object */
1065 PyObject **p = va_arg(*p_va, PyObject **);
Guido van Rossum572dbf82007-04-27 23:53:51 +00001066 if (PyString_Check(arg) || PyUnicode_Check(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001067 *p = arg;
1068 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001069 return converterr("string", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001070 break;
1071 }
1072
1073 case 'U': { /* Unicode object */
1074 PyObject **p = va_arg(*p_va, PyObject **);
1075 if (PyUnicode_Check(arg))
1076 *p = arg;
1077 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001078 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001079 break;
1080 }
1081
1082 case 'O': { /* object */
1083 PyTypeObject *type;
1084 PyObject **p;
1085 if (*format == '!') {
1086 type = va_arg(*p_va, PyTypeObject*);
1087 p = va_arg(*p_va, PyObject **);
1088 format++;
Guido van Rossumcbfc8552001-08-28 16:37:51 +00001089 if (PyType_IsSubtype(arg->ob_type, type))
Guido van Rossume826ef02000-03-10 23:02:17 +00001090 *p = arg;
1091 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001092 return converterr(type->tp_name, arg, msgbuf, bufsize);
Guido van Rossumfccfe891998-05-15 22:04:07 +00001093
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001094 }
1095 else if (*format == '?') {
1096 inquiry pred = va_arg(*p_va, inquiry);
1097 p = va_arg(*p_va, PyObject **);
1098 format++;
1099 if ((*pred)(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001100 *p = arg;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001101 else
1102 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001103 arg, msgbuf, bufsize);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001104
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001105 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001106 else if (*format == '&') {
1107 typedef int (*converter)(PyObject *, void *);
1108 converter convert = va_arg(*p_va, converter);
1109 void *addr = va_arg(*p_va, void *);
1110 format++;
1111 if (! (*convert)(arg, addr))
1112 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001113 arg, msgbuf, bufsize);
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001114 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001115 else {
1116 p = va_arg(*p_va, PyObject **);
1117 *p = arg;
1118 }
1119 break;
1120 }
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001121
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001122
1123 case 'w': { /* memory buffer, read-write access */
1124 void **p = va_arg(*p_va, void **);
1125 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1126 int count;
1127
1128 if (pb == NULL ||
1129 pb->bf_getwritebuffer == NULL ||
1130 pb->bf_getsegcount == NULL)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001131 return converterr("read-write buffer", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001132 if ((*pb->bf_getsegcount)(arg, NULL) != 1)
1133 return converterr("single-segment read-write buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001134 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001135 if ((count = pb->bf_getwritebuffer(arg, 0, p)) < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001136 return converterr("(unspecified)", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001137 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001138 FETCH_SIZE;
1139 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001140 format++;
1141 }
1142 break;
1143 }
1144
1145 case 't': { /* 8-bit character buffer, read-only access */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001146 char **p = va_arg(*p_va, char **);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001147 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001148 int count;
1149
1150 if (*format++ != '#')
1151 return converterr(
1152 "invalid use of 't' format character",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001153 arg, msgbuf, bufsize);
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001154 if (pb == NULL || pb->bf_getcharbuffer == NULL ||
Jeremy Hylton4819e972001-10-11 14:40:37 +00001155 pb->bf_getsegcount == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001156 return converterr(
1157 "string or read-only character buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001158 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001159
Jeremy Hylton4819e972001-10-11 14:40:37 +00001160 if (pb->bf_getsegcount(arg, NULL) != 1)
1161 return converterr(
1162 "string or single-segment read-only buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001163 arg, msgbuf, bufsize);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001164
1165 count = pb->bf_getcharbuffer(arg, 0, p);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001166 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001167 return converterr("(unspecified)", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001168 {
1169 FETCH_SIZE;
1170 STORE_SIZE(count);
1171 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001172 break;
1173 }
1174
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001175 default:
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001176 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001177
1178 }
1179
1180 *p_format = format;
1181 return NULL;
1182}
Guido van Rossumaa354651996-08-19 19:32:04 +00001183
Martin v. Löwis18e16552006-02-15 17:27:45 +00001184static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001185convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001186{
1187 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001188 Py_ssize_t count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001189 if (pb == NULL ||
1190 pb->bf_getreadbuffer == NULL ||
1191 pb->bf_getsegcount == NULL) {
1192 *errmsg = "string or read-only buffer";
1193 return -1;
1194 }
1195 if ((*pb->bf_getsegcount)(arg, NULL) != 1) {
1196 *errmsg = "string or single-segment read-only buffer";
1197 return -1;
1198 }
1199 if ((count = (*pb->bf_getreadbuffer)(arg, 0, p)) < 0) {
1200 *errmsg = "(unspecified)";
1201 }
1202 return count;
1203}
Guido van Rossumaa354651996-08-19 19:32:04 +00001204
1205/* Support for keyword arguments donated by
1206 Geoff Philbrick <philbric@delphi.hks.com> */
1207
Tim Petersf8cd3e82001-10-27 04:26:57 +00001208/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001209int
1210PyArg_ParseTupleAndKeywords(PyObject *args,
1211 PyObject *keywords,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001212 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001213 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001214{
1215 int retval;
1216 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001217
1218 if ((args == NULL || !PyTuple_Check(args)) ||
1219 (keywords != NULL && !PyDict_Check(keywords)) ||
1220 format == NULL ||
1221 kwlist == NULL)
1222 {
1223 PyErr_BadInternalCall();
Tim Petersf8cd3e82001-10-27 04:26:57 +00001224 return 0;
Tim Peters45772cd2001-10-27 03:58:40 +00001225 }
1226
Guido van Rossumaa354651996-08-19 19:32:04 +00001227 va_start(va, kwlist);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001228 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1229 va_end(va);
1230 return retval;
1231}
1232
1233int
1234_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1235 PyObject *keywords,
1236 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001237 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001238{
1239 int retval;
1240 va_list va;
1241
1242 if ((args == NULL || !PyTuple_Check(args)) ||
1243 (keywords != NULL && !PyDict_Check(keywords)) ||
1244 format == NULL ||
1245 kwlist == NULL)
1246 {
1247 PyErr_BadInternalCall();
1248 return 0;
1249 }
1250
1251 va_start(va, kwlist);
1252 retval = vgetargskeywords(args, keywords, format,
1253 kwlist, &va, FLAG_SIZE_T);
Guido van Rossumaa354651996-08-19 19:32:04 +00001254 va_end(va);
1255 return retval;
1256}
1257
1258
Brett Cannon711e7d92004-07-10 22:20:32 +00001259int
1260PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001261 PyObject *keywords,
1262 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001263 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001264{
1265 int retval;
1266 va_list lva;
1267
1268 if ((args == NULL || !PyTuple_Check(args)) ||
1269 (keywords != NULL && !PyDict_Check(keywords)) ||
1270 format == NULL ||
1271 kwlist == NULL)
1272 {
1273 PyErr_BadInternalCall();
1274 return 0;
1275 }
1276
1277#ifdef VA_LIST_IS_ARRAY
1278 memcpy(lva, va, sizeof(va_list));
1279#else
1280#ifdef __va_copy
1281 __va_copy(lva, va);
1282#else
1283 lva = va;
1284#endif
1285#endif
1286
Martin v. Löwis18e16552006-02-15 17:27:45 +00001287 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1288 return retval;
1289}
1290
1291int
1292_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1293 PyObject *keywords,
1294 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001295 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001296{
1297 int retval;
1298 va_list lva;
1299
1300 if ((args == NULL || !PyTuple_Check(args)) ||
1301 (keywords != NULL && !PyDict_Check(keywords)) ||
1302 format == NULL ||
1303 kwlist == NULL)
1304 {
1305 PyErr_BadInternalCall();
1306 return 0;
1307 }
1308
1309#ifdef VA_LIST_IS_ARRAY
1310 memcpy(lva, va, sizeof(va_list));
1311#else
1312#ifdef __va_copy
1313 __va_copy(lva, va);
1314#else
1315 lva = va;
1316#endif
1317#endif
1318
1319 retval = vgetargskeywords(args, keywords, format,
1320 kwlist, &lva, FLAG_SIZE_T);
Brett Cannon711e7d92004-07-10 22:20:32 +00001321 return retval;
1322}
1323
1324
Guido van Rossumaa354651996-08-19 19:32:04 +00001325static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001326vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001327 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001328{
Tim Petersdc5eff92001-10-27 06:53:00 +00001329 char msgbuf[512];
Guido van Rossumaa354651996-08-19 19:32:04 +00001330 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001331 const char *fname, *message;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001332 int min, max;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001333 const char *formatsave;
Tim Petersb639d492001-10-27 07:00:56 +00001334 int i, len, nargs, nkeywords;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001335 const char *msg;
1336 char **p;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001337 PyObject *freelist = NULL;
Tim Petersf4331c12001-10-27 00:17:34 +00001338
Tim Peters45772cd2001-10-27 03:58:40 +00001339 assert(args != NULL && PyTuple_Check(args));
1340 assert(keywords == NULL || PyDict_Check(keywords));
1341 assert(format != NULL);
1342 assert(kwlist != NULL);
1343 assert(p_va != NULL);
1344
Tim Petersf8cd3e82001-10-27 04:26:57 +00001345 /* Search the format:
1346 message <- error msg, if any (else NULL).
Tim Peterscffed4b2001-11-29 03:26:37 +00001347 fname <- routine name, if any (else NULL).
Tim Petersf8cd3e82001-10-27 04:26:57 +00001348 min <- # of required arguments, or -1 if all are required.
1349 max <- most arguments (required + optional).
Tim Peters62d48e12001-10-27 06:42:16 +00001350 Check that kwlist has a non-NULL entry for each arg.
Tim Petersf8cd3e82001-10-27 04:26:57 +00001351 Raise error if a tuple arg spec is found.
1352 */
1353 fname = message = NULL;
Tim Peters6fb26352001-10-27 04:38:11 +00001354 formatsave = format;
Tim Peters62d48e12001-10-27 06:42:16 +00001355 p = kwlist;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001356 min = -1;
1357 max = 0;
1358 while ((i = *format++) != '\0') {
Neal Norwitz30b5c5d2005-12-19 06:05:18 +00001359 if (isalpha(Py_CHARMASK(i)) && i != 'e') {
Tim Petersf8cd3e82001-10-27 04:26:57 +00001360 max++;
Tim Peters62d48e12001-10-27 06:42:16 +00001361 if (*p == NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001362 PyErr_SetString(PyExc_RuntimeError,
1363 "more argument specifiers than "
1364 "keyword list entries");
Tim Peters62d48e12001-10-27 06:42:16 +00001365 return 0;
1366 }
1367 p++;
1368 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001369 else if (i == '|')
1370 min = max;
1371 else if (i == ':') {
1372 fname = format;
1373 break;
1374 }
1375 else if (i == ';') {
1376 message = format;
1377 break;
1378 }
1379 else if (i == '(') {
Tim Peterscffed4b2001-11-29 03:26:37 +00001380 PyErr_SetString(PyExc_RuntimeError,
1381 "tuple found in format when using keyword "
1382 "arguments");
Guido van Rossumaa354651996-08-19 19:32:04 +00001383 return 0;
1384 }
Tim Peters62d48e12001-10-27 06:42:16 +00001385 }
1386 format = formatsave;
1387 if (*p != NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001388 PyErr_SetString(PyExc_RuntimeError,
1389 "more keyword list entries than "
1390 "argument specifiers");
Tim Peters62d48e12001-10-27 06:42:16 +00001391 return 0;
1392 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001393 if (min < 0) {
1394 /* All arguments are required. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001395 min = max;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001396 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001397
Tim Peters6fb26352001-10-27 04:38:11 +00001398 nargs = PyTuple_GET_SIZE(args);
Tim Petersb0872fc2001-10-27 04:45:34 +00001399 nkeywords = keywords == NULL ? 0 : PyDict_Size(keywords);
Tim Petersf8cd3e82001-10-27 04:26:57 +00001400
Guido van Rossumaa354651996-08-19 19:32:04 +00001401 /* make sure there are no duplicate values for an argument;
1402 its not clear when to use the term "keyword argument vs.
1403 keyword parameter in messages */
Tim Petersb054be42001-10-27 05:07:41 +00001404 if (nkeywords > 0) {
Tim Peters6fb26352001-10-27 04:38:11 +00001405 for (i = 0; i < nargs; i++) {
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001406 const char *thiskw = kwlist[i];
Tim Petersa9f47392001-10-27 00:46:09 +00001407 if (thiskw == NULL)
1408 break;
Tim Peters077f5742001-10-27 05:50:39 +00001409 if (PyDict_GetItemString(keywords, thiskw)) {
Tim Petersb054be42001-10-27 05:07:41 +00001410 PyErr_Format(PyExc_TypeError,
1411 "keyword parameter '%s' was given "
1412 "by position and by name",
Tim Petersa9f47392001-10-27 00:46:09 +00001413 thiskw);
Guido van Rossumaa354651996-08-19 19:32:04 +00001414 return 0;
1415 }
Tim Peters0af49162001-10-27 06:14:32 +00001416 else if (PyErr_Occurred())
1417 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001418 }
1419 }
Tim Peters61dde632001-10-27 05:30:17 +00001420
Guido van Rossumaa354651996-08-19 19:32:04 +00001421 /* required arguments missing from args can be supplied by keyword
Georg Brandld7048172006-01-20 17:53:27 +00001422 arguments; set len to the number of positional arguments, and,
Tim Peters62d48e12001-10-27 06:42:16 +00001423 if that's less than the minimum required, add in the number of
1424 required arguments that are supplied by keywords */
Tim Peters6fb26352001-10-27 04:38:11 +00001425 len = nargs;
Tim Peters62d48e12001-10-27 06:42:16 +00001426 if (nkeywords > 0 && nargs < min) {
Tim Peters6fb26352001-10-27 04:38:11 +00001427 for (i = nargs; i < min; i++) {
Tim Peters077f5742001-10-27 05:50:39 +00001428 if (PyDict_GetItemString(keywords, kwlist[i]))
Guido van Rossumaa354651996-08-19 19:32:04 +00001429 len++;
Tim Peters0af49162001-10-27 06:14:32 +00001430 else if (PyErr_Occurred())
1431 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001432 }
1433 }
Tim Peters0af49162001-10-27 06:14:32 +00001434
Guido van Rossumaa354651996-08-19 19:32:04 +00001435 /* make sure we got an acceptable number of arguments; the message
1436 is a little confusing with keywords since keyword arguments
1437 which are supplied, but don't match the required arguments
Michael W. Hudson5253c302005-03-30 16:41:55 +00001438 are not included in the "%d given" part of the message
1439 XXX and this isn't a bug!? */
Guido van Rossumaa354651996-08-19 19:32:04 +00001440 if (len < min || max < len) {
1441 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +00001442 PyOS_snprintf(msgbuf, sizeof(msgbuf),
1443 "%.200s%s takes %s %d argument%s "
1444 "(%d given)",
1445 fname==NULL ? "function" : fname,
1446 fname==NULL ? "" : "()",
1447 min==max ? "exactly"
1448 : len < min ? "at least" : "at most",
1449 len < min ? min : max,
1450 (len < min ? min : max) == 1 ? "" : "s",
1451 len);
Guido van Rossumaa354651996-08-19 19:32:04 +00001452 message = msgbuf;
1453 }
1454 PyErr_SetString(PyExc_TypeError, message);
1455 return 0;
1456 }
Tim Petersc2f01122001-10-27 07:25:06 +00001457
1458 /* convert the positional arguments */
Tim Peters6fb26352001-10-27 04:38:11 +00001459 for (i = 0; i < nargs; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001460 if (*format == '|')
1461 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +00001462 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001463 flags, levels, msgbuf, sizeof(msgbuf),
1464 &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001465 if (msg) {
1466 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001467 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001468 }
1469 }
1470
Tim Petersc2f01122001-10-27 07:25:06 +00001471 /* handle no keyword parameters in call */
Tim Petersb054be42001-10-27 05:07:41 +00001472 if (nkeywords == 0)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001473 return cleanreturn(1, freelist);
Tim Petersb054be42001-10-27 05:07:41 +00001474
Guido van Rossumaa354651996-08-19 19:32:04 +00001475 /* convert the keyword arguments; this uses the format
1476 string where it was left after processing args */
Tim Petersb639d492001-10-27 07:00:56 +00001477 for (i = nargs; i < max; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001478 PyObject *item;
Guido van Rossumaa354651996-08-19 19:32:04 +00001479 if (*format == '|')
1480 format++;
Tim Peters077f5742001-10-27 05:50:39 +00001481 item = PyDict_GetItemString(keywords, kwlist[i]);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001482 if (item != NULL) {
Tim Peters077f5742001-10-27 05:50:39 +00001483 Py_INCREF(item);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001484 msg = convertitem(item, &format, p_va, flags, levels,
1485 msgbuf, sizeof(msgbuf), &freelist);
Tim Peters077f5742001-10-27 05:50:39 +00001486 Py_DECREF(item);
Guido van Rossumaa354651996-08-19 19:32:04 +00001487 if (msg) {
1488 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001489 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001490 }
Tim Petersc2f01122001-10-27 07:25:06 +00001491 --nkeywords;
1492 if (nkeywords == 0)
1493 break;
Guido van Rossumaa354651996-08-19 19:32:04 +00001494 }
Tim Peters0af49162001-10-27 06:14:32 +00001495 else if (PyErr_Occurred())
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001496 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001497 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001498 msg = skipitem(&format, p_va, flags);
Guido van Rossumaa354651996-08-19 19:32:04 +00001499 if (msg) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001500 levels[0] = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001501 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001502 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001503 }
1504 }
1505 }
Tim Petersb054be42001-10-27 05:07:41 +00001506
Guido van Rossumaa354651996-08-19 19:32:04 +00001507 /* make sure there are no extraneous keyword arguments */
Tim Petersc2f01122001-10-27 07:25:06 +00001508 if (nkeywords > 0) {
1509 PyObject *key, *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001510 Py_ssize_t pos = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001511 while (PyDict_Next(keywords, &pos, &key, &value)) {
Tim Petersc2f01122001-10-27 07:25:06 +00001512 int match = 0;
Guido van Rossum55474762002-04-04 16:22:30 +00001513 char *ks;
Guido van Rossum572dbf82007-04-27 23:53:51 +00001514 if (!PyString_Check(key) && !PyUnicode_Check(key)) {
Guido van Rossum55474762002-04-04 16:22:30 +00001515 PyErr_SetString(PyExc_TypeError,
1516 "keywords must be strings");
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001517 return cleanreturn(0, freelist);
Guido van Rossum55474762002-04-04 16:22:30 +00001518 }
1519 ks = PyString_AsString(key);
Tim Petersb639d492001-10-27 07:00:56 +00001520 for (i = 0; i < max; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001521 if (!strcmp(ks, kwlist[i])) {
1522 match = 1;
1523 break;
1524 }
1525 }
1526 if (!match) {
Tim Petersc2f01122001-10-27 07:25:06 +00001527 PyErr_Format(PyExc_TypeError,
1528 "'%s' is an invalid keyword "
1529 "argument for this function",
1530 ks);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001531 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001532 }
1533 }
1534 }
Tim Petersc2f01122001-10-27 07:25:06 +00001535
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001536 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001537}
1538
1539
1540static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001541skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001542{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001543 const char *format = *p_format;
Guido van Rossumaa354651996-08-19 19:32:04 +00001544 char c = *format++;
1545
1546 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001547
1548 /* simple codes
1549 * The individual types (second arg of va_arg) are irrelevant */
1550
Guido van Rossumaa354651996-08-19 19:32:04 +00001551 case 'b': /* byte -- very short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001552 case 'B': /* byte as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001553 case 'h': /* short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001554 case 'H': /* short int as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001555 case 'i': /* int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001556 case 'I': /* int sized bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001557 case 'l': /* long int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001558 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001559#ifdef HAVE_LONG_LONG
Georg Brandl6dd14612005-09-14 19:29:53 +00001560 case 'L': /* PY_LONG_LONG */
1561 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001562#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001563 case 'f': /* float */
Guido van Rossumaa354651996-08-19 19:32:04 +00001564 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001565#ifndef WITHOUT_COMPLEX
1566 case 'D': /* complex double */
Georg Brandl6dd14612005-09-14 19:29:53 +00001567#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001568 case 'c': /* char */
1569 {
Georg Brandl6dd14612005-09-14 19:29:53 +00001570 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001571 break;
1572 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001573
1574 case 'n': /* Py_ssize_t */
1575 {
1576 (void) va_arg(*p_va, Py_ssize_t *);
1577 break;
1578 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001579
Georg Brandl6dd14612005-09-14 19:29:53 +00001580 /* string codes */
1581
1582 case 'e': /* string with encoding */
1583 {
1584 (void) va_arg(*p_va, const char *);
1585 if (!(*format == 's' || *format == 't'))
1586 /* after 'e', only 's' and 't' is allowed */
1587 goto err;
1588 format++;
1589 /* explicit fallthrough to string cases */
1590 }
1591
Guido van Rossumaa354651996-08-19 19:32:04 +00001592 case 's': /* string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001593 case 'z': /* string or None */
Georg Brandl6dd14612005-09-14 19:29:53 +00001594 case 'u': /* unicode string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001595 case 't': /* buffer, read-only */
1596 case 'w': /* buffer, read-write */
Guido van Rossumaa354651996-08-19 19:32:04 +00001597 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001598 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001599 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001600 if (flags & FLAG_SIZE_T)
1601 (void) va_arg(*p_va, Py_ssize_t *);
1602 else
1603 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001604 format++;
1605 }
1606 break;
1607 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001608
1609 /* object codes */
1610
Guido van Rossumaa354651996-08-19 19:32:04 +00001611 case 'S': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001612 case 'U': /* unicode string object */
Guido van Rossumaa354651996-08-19 19:32:04 +00001613 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001614 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001615 break;
1616 }
1617
1618 case 'O': /* object */
1619 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001620 if (*format == '!') {
1621 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001622 (void) va_arg(*p_va, PyTypeObject*);
1623 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001624 }
1625#if 0
1626/* I don't know what this is for */
1627 else if (*format == '?') {
1628 inquiry pred = va_arg(*p_va, inquiry);
1629 format++;
1630 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001631 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001632 }
1633 }
1634#endif
1635 else if (*format == '&') {
Tim Petersdbd9ba62000-07-09 03:09:57 +00001636 typedef int (*converter)(PyObject *, void *);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001637 (void) va_arg(*p_va, converter);
1638 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001639 format++;
1640 }
1641 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001642 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001643 }
1644 break;
1645 }
1646
1647 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001648err:
Guido van Rossumaa354651996-08-19 19:32:04 +00001649 return "impossible<bad format char>";
1650
1651 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001652
1653 /* The "(...)" format code for tuples is not handled here because
1654 * it is not allowed with keyword args. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001655
1656 *p_format = format;
1657 return NULL;
1658}
Fred Drakee4616e62001-10-23 21:09:29 +00001659
1660
1661int
Martin v. Löwis76246742006-03-01 04:06:10 +00001662PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001663{
Martin v. Löwis76246742006-03-01 04:06:10 +00001664 Py_ssize_t i, l;
Fred Drakee4616e62001-10-23 21:09:29 +00001665 PyObject **o;
1666 va_list vargs;
1667
1668#ifdef HAVE_STDARG_PROTOTYPES
1669 va_start(vargs, max);
1670#else
1671 va_start(vargs);
1672#endif
1673
1674 assert(min >= 0);
1675 assert(min <= max);
1676 if (!PyTuple_Check(args)) {
1677 PyErr_SetString(PyExc_SystemError,
1678 "PyArg_UnpackTuple() argument list is not a tuple");
1679 return 0;
1680 }
1681 l = PyTuple_GET_SIZE(args);
1682 if (l < min) {
1683 if (name != NULL)
1684 PyErr_Format(
1685 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001686 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001687 name, (min == max ? "" : "at least "), min, l);
1688 else
1689 PyErr_Format(
1690 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001691 "unpacked tuple should have %s%zd elements,"
1692 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001693 (min == max ? "" : "at least "), min, l);
1694 va_end(vargs);
1695 return 0;
1696 }
1697 if (l > max) {
1698 if (name != NULL)
1699 PyErr_Format(
1700 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001701 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001702 name, (min == max ? "" : "at most "), max, l);
1703 else
1704 PyErr_Format(
1705 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001706 "unpacked tuple should have %s%zd elements,"
1707 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001708 (min == max ? "" : "at most "), max, l);
1709 va_end(vargs);
1710 return 0;
1711 }
1712 for (i = 0; i < l; i++) {
1713 o = va_arg(vargs, PyObject **);
1714 *o = PyTuple_GET_ITEM(args, i);
1715 }
1716 va_end(vargs);
1717 return 1;
1718}
Georg Brandl02c42872005-08-26 06:42:30 +00001719
1720
1721/* For type constructors that don't take keyword args
1722 *
1723 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001724 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001725 */
1726int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001727_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001728{
1729 if (kw == NULL)
1730 return 1;
1731 if (!PyDict_CheckExact(kw)) {
1732 PyErr_BadInternalCall();
1733 return 0;
1734 }
1735 if (PyDict_Size(kw) == 0)
1736 return 1;
1737
1738 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1739 funcname);
1740 return 0;
1741}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001742#ifdef __cplusplus
1743};
1744#endif