blob: 3b58c98295d8b719a5bacf554bb9195c8018e09e [file] [log] [blame]
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001
2/* New getargs implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00005
Guido van Rossumc1d50531996-08-21 23:38:24 +00006#include <ctype.h>
7
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00008
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00009#ifdef __cplusplus
10extern "C" {
11#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000012int PyArg_Parse(PyObject *, const char *, ...);
13int PyArg_ParseTuple(PyObject *, const char *, ...);
14int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000015
Tim Petersdbd9ba62000-07-09 03:09:57 +000016int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000017 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000018int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000019 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000020
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000021#ifdef HAVE_DECLSPEC_DLL
22/* Export functions */
23PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, char *, ...);
24PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, char *, ...);
25PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
26 const char *, char **, ...);
27PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
28PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, char *, va_list);
29PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
30 const char *, char **, va_list);
31#endif
32
Martin v. Löwis18e16552006-02-15 17:27:45 +000033#define FLAG_COMPAT 1
34#define FLAG_SIZE_T 2
35
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000036
37/* Forward */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000038static int vgetargs1(PyObject *, const char *, va_list *, int);
39static void seterror(int, const char *, int *, const char *, const char *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000040static char *convertitem(PyObject *, const char **, va_list *, int, int *,
41 char *, size_t, PyObject **);
42static char *converttuple(PyObject *, const char **, va_list *, int,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +000043 int *, char *, size_t, int, PyObject **);
Martin v. Löwis18e16552006-02-15 17:27:45 +000044static char *convertsimple(PyObject *, const char **, va_list *, int, char *,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +000045 size_t, PyObject **);
Martin v. Löwis18e16552006-02-15 17:27:45 +000046static Py_ssize_t convertbuffer(PyObject *, void **p, char **);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000047
Tim Petersdbd9ba62000-07-09 03:09:57 +000048static int vgetargskeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000049 const char *, char **, va_list *, int);
Martin v. Löwis18e16552006-02-15 17:27:45 +000050static char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000051
Fred Drake563dfc22001-10-23 14:41:08 +000052int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000053PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000054{
55 int retval;
56 va_list va;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000057
58 va_start(va, format);
Martin v. Löwis18e16552006-02-15 17:27:45 +000059 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
60 va_end(va);
61 return retval;
62}
63
64int
65_PyArg_Parse_SizeT(PyObject *args, char *format, ...)
66{
67 int retval;
68 va_list va;
69
70 va_start(va, format);
71 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000072 va_end(va);
73 return retval;
74}
75
76
Fred Drake563dfc22001-10-23 14:41:08 +000077int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000078PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000079{
80 int retval;
81 va_list va;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000082
83 va_start(va, format);
Guido van Rossum1ae940a1995-01-02 19:04:15 +000084 retval = vgetargs1(args, format, &va, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000085 va_end(va);
86 return retval;
87}
88
Martin v. Löwis18e16552006-02-15 17:27:45 +000089int
90_PyArg_ParseTuple_SizeT(PyObject *args, char *format, ...)
91{
92 int retval;
93 va_list va;
94
95 va_start(va, format);
96 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
97 va_end(va);
98 return retval;
99}
100
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000101
102int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000103PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000104{
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000105 va_list lva;
106
107#ifdef VA_LIST_IS_ARRAY
108 memcpy(lva, va, sizeof(va_list));
109#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000110#ifdef __va_copy
111 __va_copy(lva, va);
112#else
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000113 lva = va;
114#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000115#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000116
117 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000118}
119
Martin v. Löwis18e16552006-02-15 17:27:45 +0000120int
121_PyArg_VaParse_SizeT(PyObject *args, char *format, va_list va)
122{
123 va_list lva;
124
125#ifdef VA_LIST_IS_ARRAY
126 memcpy(lva, va, sizeof(va_list));
127#else
128#ifdef __va_copy
129 __va_copy(lva, va);
130#else
131 lva = va;
132#endif
133#endif
134
135 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
136}
137
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000138
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000139/* Handle cleanup of allocated memory in case of exception */
140
141static int
142addcleanup(void *ptr, PyObject **freelist)
143{
144 PyObject *cobj;
145 if (!*freelist) {
146 *freelist = PyList_New(0);
147 if (!*freelist) {
148 PyMem_FREE(ptr);
149 return -1;
150 }
151 }
152 cobj = PyCObject_FromVoidPtr(ptr, NULL);
153 if (!cobj) {
154 PyMem_FREE(ptr);
155 return -1;
156 }
157 if(PyList_Append(*freelist, cobj)) {
158 PyMem_FREE(ptr);
159 Py_DECREF(cobj);
160 return -1;
161 }
162 Py_DECREF(cobj);
163 return 0;
164}
165
166static int
167cleanreturn(int retval, PyObject *freelist)
168{
169 if(freelist) {
170 if((retval) == 0) {
Martin v. Löwisd96ee902006-02-16 14:37:16 +0000171 Py_ssize_t len = PyList_GET_SIZE(freelist), i;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000172 for (i = 0; i < len; i++)
173 PyMem_FREE(PyCObject_AsVoidPtr(
174 PyList_GET_ITEM(freelist, i)));
175 }
176 Py_DECREF(freelist);
177 }
178 return retval;
179}
180
181
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000182static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000183vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000184{
185 char msgbuf[256];
186 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000187 const char *fname = NULL;
188 const char *message = NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000189 int min = -1;
190 int max = 0;
191 int level = 0;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000192 int endfmt = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000193 const char *formatsave = format;
Martin v. Löwisd96ee902006-02-16 14:37:16 +0000194 Py_ssize_t i, len;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000195 char *msg;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000196 PyObject *freelist = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000197 int compat = flags & FLAG_COMPAT;
198
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000199 assert(compat || (args != (PyObject*)NULL));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000200 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000201
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000202 while (endfmt == 0) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000203 int c = *format++;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000204 switch (c) {
205 case '(':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000206 if (level == 0)
207 max++;
208 level++;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000209 if (level >= 30)
210 Py_FatalError("too many tuple nesting levels "
211 "in argument format string");
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000212 break;
213 case ')':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000214 if (level == 0)
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000215 Py_FatalError("excess ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000216 else
217 level--;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000218 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000219 case '\0':
220 endfmt = 1;
221 break;
222 case ':':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000223 fname = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000224 endfmt = 1;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000225 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000226 case ';':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000227 message = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000228 endfmt = 1;
229 break;
230 default:
231 if (level == 0) {
232 if (c == 'O')
233 max++;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000234 else if (isalpha(Py_CHARMASK(c))) {
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000235 if (c != 'e') /* skip encoded */
236 max++;
237 } else if (c == '|')
238 min = max;
239 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000240 break;
241 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000242 }
243
244 if (level != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000245 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000246
247 if (min < 0)
248 min = max;
249
250 format = formatsave;
251
252 if (compat) {
253 if (max == 0) {
254 if (args == NULL)
255 return 1;
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000256 PyOS_snprintf(msgbuf, sizeof(msgbuf),
257 "%.200s%s takes no arguments",
258 fname==NULL ? "function" : fname,
259 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000260 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000261 return 0;
262 }
263 else if (min == 1 && max == 1) {
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000264 if (args == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000265 PyOS_snprintf(msgbuf, sizeof(msgbuf),
266 "%.200s%s takes at least one argument",
267 fname==NULL ? "function" : fname,
268 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000269 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000270 return 0;
271 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000272 msg = convertitem(args, &format, p_va, flags, levels,
273 msgbuf, sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000274 if (msg == NULL)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000275 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000276 seterror(levels[0], msg, levels+1, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000277 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000278 }
279 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000280 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000281 "old style getargs format uses new features");
282 return 0;
283 }
284 }
285
Guido van Rossum79f25d91997-04-29 20:08:16 +0000286 if (!PyTuple_Check(args)) {
287 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000288 "new style getargs format but argument is not a tuple");
289 return 0;
290 }
291
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000292 len = PyTuple_GET_SIZE(args);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000293
294 if (len < min || max < len) {
295 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000296 PyOS_snprintf(msgbuf, sizeof(msgbuf),
297 "%.150s%s takes %s %d argument%s "
Neal Norwitz20dd93f2006-02-19 19:34:15 +0000298 "(%ld given)",
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000299 fname==NULL ? "function" : fname,
300 fname==NULL ? "" : "()",
301 min==max ? "exactly"
302 : len < min ? "at least" : "at most",
303 len < min ? min : max,
304 (len < min ? min : max) == 1 ? "" : "s",
Neal Norwitz9a276172006-02-20 18:57:39 +0000305 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000306 message = msgbuf;
307 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000308 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000309 return 0;
310 }
311
312 for (i = 0; i < len; i++) {
313 if (*format == '|')
314 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000315 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000316 flags, levels, msgbuf,
317 sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000318 if (msg) {
319 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000320 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000321 }
322 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000323
Neal Norwitz4ac13df2005-12-19 06:10:07 +0000324 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
Guido van Rossum7d4f68c1997-12-19 04:25:23 +0000325 *format != '(' &&
Guido van Rossum231a41e1997-12-09 20:36:39 +0000326 *format != '|' && *format != ':' && *format != ';') {
327 PyErr_Format(PyExc_SystemError,
Guido van Rossum0d6b49e1998-01-19 22:22:44 +0000328 "bad format string: %.200s", formatsave);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000329 return cleanreturn(0, freelist);
Guido van Rossum231a41e1997-12-09 20:36:39 +0000330 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000331
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000332 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000333}
334
335
336
337static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000338seterror(int iarg, const char *msg, int *levels, const char *fname,
339 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000340{
Marc-André Lemburgd4c0a9c2001-11-28 11:47:00 +0000341 char buf[512];
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000342 int i;
343 char *p = buf;
344
Guido van Rossum79f25d91997-04-29 20:08:16 +0000345 if (PyErr_Occurred())
Guido van Rossum64fc6491995-01-21 14:09:37 +0000346 return;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000347 else if (message == NULL) {
348 if (fname != NULL) {
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000349 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000350 p += strlen(p);
351 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000352 if (iarg != 0) {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000353 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000354 "argument %d", iarg);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000355 i = 0;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000356 p += strlen(p);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000357 while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
358 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000359 ", item %d", levels[i]-1);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000360 p += strlen(p);
361 i++;
362 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000363 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000364 else {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000365 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
Ka-Ping Yee20579702001-01-15 22:14:16 +0000366 p += strlen(p);
367 }
Tim Petersfaad5ad2001-12-03 00:43:33 +0000368 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000369 message = buf;
370 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000371 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000372}
373
374
375/* Convert a tuple argument.
376 On entry, *p_format points to the character _after_ the opening '('.
377 On successful exit, *p_format points to the closing ')'.
378 If successful:
379 *p_format and *p_va are updated,
380 *levels and *msgbuf are untouched,
381 and NULL is returned.
382 If the argument is invalid:
383 *p_format is unchanged,
384 *p_va is undefined,
385 *levels is a 0-terminated list of item numbers,
386 *msgbuf contains an error message, whose format is:
Ka-Ping Yee20579702001-01-15 22:14:16 +0000387 "must be <typename1>, not <typename2>", where:
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000388 <typename1> is the name of the expected type, and
389 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000390 and msgbuf is returned.
391*/
392
393static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000394converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
395 int *levels, char *msgbuf, size_t bufsize, int toplevel,
396 PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000397{
398 int level = 0;
399 int n = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000400 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000401 int i;
402
403 for (;;) {
404 int c = *format++;
405 if (c == '(') {
406 if (level == 0)
407 n++;
408 level++;
409 }
410 else if (c == ')') {
411 if (level == 0)
412 break;
413 level--;
414 }
415 else if (c == ':' || c == ';' || c == '\0')
416 break;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000417 else if (level == 0 && isalpha(Py_CHARMASK(c)))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000418 n++;
419 }
420
Ka-Ping Yee20579702001-01-15 22:14:16 +0000421 if (!PySequence_Check(arg) || PyString_Check(arg)) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000422 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000423 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000424 toplevel ? "expected %d arguments, not %.50s" :
425 "must be %d-item sequence, not %.50s",
426 n,
427 arg == Py_None ? "None" : arg->ob_type->tp_name);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000428 return msgbuf;
429 }
430
Jeremy Hylton03657cf2000-07-12 13:05:33 +0000431 if ((i = PySequence_Size(arg)) != n) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000432 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000433 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000434 toplevel ? "expected %d arguments, not %d" :
435 "must be sequence of length %d, not %d",
436 n, i);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000437 return msgbuf;
438 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000439
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000440 format = *p_format;
441 for (i = 0; i < n; i++) {
442 char *msg;
Guido van Rossum66368cc1999-02-17 23:16:43 +0000443 PyObject *item;
444 item = PySequence_GetItem(arg, i);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000445 if (item == NULL) {
446 PyErr_Clear();
447 levels[0] = i+1;
448 levels[1] = 0;
449 strncpy(msgbuf, "is not retrievable", bufsize);
450 return msgbuf;
451 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000452 msg = convertitem(item, &format, p_va, flags, levels+1,
453 msgbuf, bufsize, freelist);
Guido van Rossum66368cc1999-02-17 23:16:43 +0000454 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
455 Py_XDECREF(item);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000456 if (msg != NULL) {
457 levels[0] = i+1;
458 return msg;
459 }
460 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000461
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000462 *p_format = format;
463 return NULL;
464}
465
466
467/* Convert a single item. */
468
469static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000470convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
471 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000472{
473 char *msg;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000474 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000475
476 if (*format == '(' /* ')' */) {
477 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000478 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000479 bufsize, 0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000480 if (msg == NULL)
481 format++;
482 }
483 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000484 msg = convertsimple(arg, &format, p_va, flags,
485 msgbuf, bufsize, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000486 if (msg != NULL)
487 levels[0] = 0;
488 }
489 if (msg == NULL)
490 *p_format = format;
491 return msg;
492}
493
494
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000495
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000496#define UNICODE_DEFAULT_ENCODING(arg) \
497 _PyUnicode_AsDefaultEncodedString(arg, NULL)
498
499/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000500
501static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000502converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000503{
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000504 assert(expected != NULL);
505 assert(arg != NULL);
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000506 PyOS_snprintf(msgbuf, bufsize,
507 "must be %.50s, not %.50s", expected,
508 arg == Py_None ? "None" : arg->ob_type->tp_name);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000509 return msgbuf;
510}
511
512#define CONV_UNICODE "(unicode conversion error)"
513
Guido van Rossum45aecf42006-03-15 04:58:47 +0000514/* Explicitly check for float arguments when integers are expected.
515 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000516static int
517float_argument_error(PyObject *arg)
518{
Guido van Rossum45aecf42006-03-15 04:58:47 +0000519 if (PyFloat_Check(arg)) {
520 PyErr_SetString(PyExc_TypeError,
521 "integer argument expected, got float" );
Neil Schemenauer5042da62003-02-04 20:59:40 +0000522 return 1;
Guido van Rossum45aecf42006-03-15 04:58:47 +0000523 }
Neil Schemenauer5042da62003-02-04 20:59:40 +0000524 else
525 return 0;
526}
527
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000528/* Convert a non-tuple argument. Return NULL if conversion went OK,
529 or a string with a message describing the failure. The message is
530 formatted as "must be <desired type>, not <actual type>".
531 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000532 Don't call if a tuple is expected.
533
534 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000535*/
536
537static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000538convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000539 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000540{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000541 /* For # codes */
542#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
543 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
544 else q=va_arg(*p_va, int*);
545#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
546#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
547
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000548 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000549 char c = *format++;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000550#ifdef Py_USING_UNICODE
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000551 PyObject *uarg;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000552#endif
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000553
554 switch (c) {
555
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000556 case 'b': { /* unsigned byte -- very short int */
557 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000558 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000559 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000560 return converterr("integer<b>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000561 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000562 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000563 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000564 else if (ival < 0) {
565 PyErr_SetString(PyExc_OverflowError,
566 "unsigned byte integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000567 return converterr("integer<b>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000568 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000569 else if (ival > UCHAR_MAX) {
570 PyErr_SetString(PyExc_OverflowError,
571 "unsigned byte integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000572 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000573 }
574 else
575 *p = (unsigned char) ival;
576 break;
577 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000578
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000579 case 'B': {/* byte sized bitfield - both signed and unsigned
580 values allowed */
581 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000582 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000583 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000584 return converterr("integer<B>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000585 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000586 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000587 return converterr("integer<B>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000588 else
589 *p = (unsigned char) ival;
590 break;
591 }
Jack Jansencc22fbe2000-08-05 21:29:58 +0000592
Guido van Rossumfce26e72003-04-18 00:12:30 +0000593 case 'h': {/* signed short int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000594 short *p = va_arg(*p_va, short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000595 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000596 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000597 return converterr("integer<h>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000598 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000599 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000600 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfce26e72003-04-18 00:12:30 +0000601 else if (ival < SHRT_MIN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000602 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000603 "signed short integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000604 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000605 }
Guido van Rossumfce26e72003-04-18 00:12:30 +0000606 else if (ival > SHRT_MAX) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000607 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000608 "signed short integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000609 return converterr("integer<h>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000610 }
611 else
612 *p = (short) ival;
613 break;
614 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000615
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000616 case 'H': { /* short int sized bitfield, both signed and
617 unsigned allowed */
618 unsigned short *p = va_arg(*p_va, unsigned short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000619 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000620 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000621 return converterr("integer<H>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000622 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000623 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000624 return converterr("integer<H>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000625 else
626 *p = (unsigned short) ival;
627 break;
628 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000629
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000630 case 'i': {/* signed int */
631 int *p = va_arg(*p_va, int *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000632 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000633 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000634 return converterr("integer<i>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000635 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000636 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000637 return converterr("integer<i>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000638 else if (ival > INT_MAX) {
639 PyErr_SetString(PyExc_OverflowError,
640 "signed integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000641 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000642 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000643 else if (ival < INT_MIN) {
644 PyErr_SetString(PyExc_OverflowError,
645 "signed integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000646 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000647 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000648 else
649 *p = ival;
650 break;
651 }
652
Thomas Hellera4ea6032003-04-17 18:55:45 +0000653 case 'I': { /* int sized bitfield, both signed and
654 unsigned allowed */
655 unsigned int *p = va_arg(*p_va, unsigned int *);
656 unsigned int ival;
657 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000658 return converterr("integer<I>", arg, msgbuf, bufsize);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000659 ival = (unsigned int)PyInt_AsUnsignedLongMask(arg);
660 if (ival == (unsigned int)-1 && PyErr_Occurred())
Thomas Hellera4ea6032003-04-17 18:55:45 +0000661 return converterr("integer<I>", arg, msgbuf, bufsize);
662 else
663 *p = ival;
664 break;
665 }
666
Martin v. Löwis18e16552006-02-15 17:27:45 +0000667 case 'n': /* Py_ssize_t */
668#if SIZEOF_SIZE_T != SIZEOF_LONG
669 {
670 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
671 Py_ssize_t ival;
672 if (float_argument_error(arg))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000673 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000674 ival = PyInt_AsSsize_t(arg);
675 if (ival == -1 && PyErr_Occurred())
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000676 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000677 *p = ival;
678 break;
679 }
680#endif
681 /* Fall through from 'n' to 'l' if Py_ssize_t is int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000682 case 'l': {/* long int */
683 long *p = va_arg(*p_va, long *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000684 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000685 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000686 return converterr("integer<l>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000687 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000688 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000689 return converterr("integer<l>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000690 else
691 *p = ival;
692 break;
693 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000694
695 case 'k': { /* long sized bitfield */
696 unsigned long *p = va_arg(*p_va, unsigned long *);
697 unsigned long ival;
698 if (PyInt_Check(arg))
699 ival = PyInt_AsUnsignedLongMask(arg);
700 else if (PyLong_Check(arg))
701 ival = PyLong_AsUnsignedLongMask(arg);
702 else
703 return converterr("integer<k>", arg, msgbuf, bufsize);
704 *p = ival;
705 break;
706 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000707
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000708#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000709 case 'L': {/* PY_LONG_LONG */
710 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
711 PY_LONG_LONG ival = PyLong_AsLongLong( arg );
712 if( ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000713 return converterr("long<L>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000714 } else {
715 *p = ival;
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000716 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000717 break;
718 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000719
720 case 'K': { /* long long sized bitfield */
721 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
722 unsigned PY_LONG_LONG ival;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000723 if (PyLong_Check(arg))
Thomas Hellera4ea6032003-04-17 18:55:45 +0000724 ival = PyLong_AsUnsignedLongLongMask(arg);
725 else
726 return converterr("integer<K>", arg, msgbuf, bufsize);
727 *p = ival;
728 break;
729 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000730#endif
731
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000732 case 'f': {/* float */
733 float *p = va_arg(*p_va, float *);
734 double dval = PyFloat_AsDouble(arg);
735 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000736 return converterr("float<f>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000737 else
738 *p = (float) dval;
739 break;
740 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000741
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000742 case 'd': {/* double */
743 double *p = va_arg(*p_va, double *);
744 double dval = PyFloat_AsDouble(arg);
745 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000746 return converterr("float<d>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000747 else
748 *p = dval;
749 break;
750 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000751
Guido van Rossum530956d1996-07-21 02:27:43 +0000752#ifndef WITHOUT_COMPLEX
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000753 case 'D': {/* complex double */
754 Py_complex *p = va_arg(*p_va, Py_complex *);
755 Py_complex cval;
756 cval = PyComplex_AsCComplex(arg);
757 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000758 return converterr("complex<D>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000759 else
760 *p = cval;
761 break;
762 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000763#endif /* WITHOUT_COMPLEX */
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000764
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000765 case 'c': {/* char */
766 char *p = va_arg(*p_va, char *);
767 if (PyString_Check(arg) && PyString_Size(arg) == 1)
Jeremy Hylton0407aea2001-10-10 02:51:57 +0000768 *p = PyString_AS_STRING(arg)[0];
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000769 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000770 return converterr("char", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000771 break;
772 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000773
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000774 case 's': {/* string */
775 if (*format == '#') {
776 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000777 FETCH_SIZE;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000778
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000779 if (PyString_Check(arg)) {
780 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000781 STORE_SIZE(PyString_GET_SIZE(arg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000782 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000783#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000784 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000785 uarg = UNICODE_DEFAULT_ENCODING(arg);
786 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000787 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000788 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000789 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000790 STORE_SIZE(PyString_GET_SIZE(uarg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000791 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000792#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000793 else { /* any buffer-like object */
794 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000795 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000796 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000797 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000798 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000799 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000800 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000801 } else {
802 char **p = va_arg(*p_va, char **);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000803
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000804 if (PyString_Check(arg))
805 *p = PyString_AS_STRING(arg);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000806#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000807 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000808 uarg = UNICODE_DEFAULT_ENCODING(arg);
809 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000810 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000811 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000812 *p = PyString_AS_STRING(uarg);
Marc-André Lemburg6f15e572001-05-02 17:16:16 +0000813 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000814#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000815 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000816 return converterr("string", arg, msgbuf, bufsize);
Thomas Wouters89f507f2006-12-13 04:49:30 +0000817 if ((Py_ssize_t)strlen(*p) != PyString_Size(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000818 return converterr("string without null bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000819 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000820 }
821 break;
822 }
823
824 case 'z': {/* string, may be NULL (None) */
825 if (*format == '#') { /* any buffer-like object */
826 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000827 FETCH_SIZE;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000828
829 if (arg == Py_None) {
830 *p = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000831 STORE_SIZE(0);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000832 }
833 else if (PyString_Check(arg)) {
834 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000835 STORE_SIZE(PyString_GET_SIZE(arg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000836 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000837#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000838 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000839 uarg = UNICODE_DEFAULT_ENCODING(arg);
840 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000841 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000842 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000843 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000844 STORE_SIZE(PyString_GET_SIZE(uarg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000845 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000846#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000847 else { /* any buffer-like object */
848 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000849 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000850 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000851 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000852 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000853 }
854 format++;
855 } else {
856 char **p = va_arg(*p_va, char **);
857
858 if (arg == Py_None)
859 *p = 0;
860 else if (PyString_Check(arg))
Jeremy Hyltona4c8cd72001-10-10 02:51:08 +0000861 *p = PyString_AS_STRING(arg);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000862#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000863 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000864 uarg = UNICODE_DEFAULT_ENCODING(arg);
865 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000866 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000867 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000868 *p = PyString_AS_STRING(uarg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000869 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000870#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000871 else
872 return converterr("string or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000873 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000874 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000875 FETCH_SIZE;
Thomas Woutersc3547a32006-03-01 21:31:21 +0000876 assert(0); /* XXX redundant with if-case */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000877 if (arg == Py_None)
878 *q = 0;
879 else
880 *q = PyString_Size(arg);
881 format++;
882 }
883 else if (*p != NULL &&
Thomas Wouters89f507f2006-12-13 04:49:30 +0000884 (Py_ssize_t)strlen(*p) != PyString_Size(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000885 return converterr(
886 "string without null bytes or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000887 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000888 }
889 break;
890 }
891
892 case 'e': {/* encoded string */
893 char **buffer;
894 const char *encoding;
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000895 PyObject *s;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000896 int size, recode_strings;
897
898 /* Get 'e' parameter: the encoding name */
899 encoding = (const char *)va_arg(*p_va, const char *);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000900#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000901 if (encoding == NULL)
902 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000903#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000904
905 /* Get output buffer parameter:
906 's' (recode all objects via Unicode) or
907 't' (only recode non-string objects)
908 */
909 if (*format == 's')
910 recode_strings = 1;
911 else if (*format == 't')
912 recode_strings = 0;
913 else
914 return converterr(
915 "(unknown parser marker combination)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000916 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000917 buffer = (char **)va_arg(*p_va, char **);
918 format++;
919 if (buffer == NULL)
920 return converterr("(buffer is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000921 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000922
923 /* Encode object */
924 if (!recode_strings && PyString_Check(arg)) {
925 s = arg;
926 Py_INCREF(s);
927 }
928 else {
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000929#ifdef Py_USING_UNICODE
930 PyObject *u;
931
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000932 /* Convert object to Unicode */
933 u = PyUnicode_FromObject(arg);
934 if (u == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000935 return converterr(
936 "string or unicode or text buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000937 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000938
939 /* Encode object; use default error handling */
940 s = PyUnicode_AsEncodedString(u,
941 encoding,
942 NULL);
943 Py_DECREF(u);
944 if (s == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000945 return converterr("(encoding failed)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000946 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000947 if (!PyString_Check(s)) {
948 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000949 return converterr(
950 "(encoder failed to return a string)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000951 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000952 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000953#else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000954 return converterr("string<e>", arg, msgbuf, bufsize);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000955#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000956 }
957 size = PyString_GET_SIZE(s);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000958
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000959 /* Write output; output is guaranteed to be 0-terminated */
960 if (*format == '#') {
961 /* Using buffer length parameter '#':
962
963 - if *buffer is NULL, a new buffer of the
964 needed size is allocated and the data
965 copied into it; *buffer is updated to point
966 to the new buffer; the caller is
967 responsible for PyMem_Free()ing it after
968 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000969
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000970 - if *buffer is not NULL, the data is
971 copied to *buffer; *buffer_len has to be
972 set to the size of the buffer on input;
973 buffer overflow is signalled with an error;
974 buffer has to provide enough room for the
975 encoded string plus the trailing 0-byte
976
977 - in both cases, *buffer_len is updated to
978 the size of the buffer /excluding/ the
979 trailing 0-byte
980
981 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000982 FETCH_SIZE;
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000983
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000984 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000985 if (q == NULL && q2 == NULL) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000986 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000987 return converterr(
988 "(buffer_len is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000989 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000990 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000991 if (*buffer == NULL) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000992 *buffer = PyMem_NEW(char, size + 1);
993 if (*buffer == NULL) {
994 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000995 return converterr(
996 "(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000997 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000998 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000999 if(addcleanup(*buffer, freelist)) {
1000 Py_DECREF(s);
1001 return converterr(
1002 "(cleanup problem)",
1003 arg, msgbuf, bufsize);
1004 }
Fred Drake25871c02000-05-03 15:17:02 +00001005 } else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001006 if (size + 1 > BUFFER_LEN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001007 Py_DECREF(s);
1008 return converterr(
1009 "(buffer overflow)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001010 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001011 }
Fred Drake25871c02000-05-03 15:17:02 +00001012 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001013 memcpy(*buffer,
1014 PyString_AS_STRING(s),
1015 size + 1);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001016 STORE_SIZE(size);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001017 } else {
1018 /* Using a 0-terminated buffer:
1019
1020 - the encoded string has to be 0-terminated
1021 for this variant to work; if it is not, an
1022 error raised
Fred Drake25871c02000-05-03 15:17:02 +00001023
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001024 - a new buffer of the needed size is
1025 allocated and the data copied into it;
1026 *buffer is updated to point to the new
1027 buffer; the caller is responsible for
1028 PyMem_Free()ing it after usage
1029
1030 */
Thomas Wouters89f507f2006-12-13 04:49:30 +00001031 if ((Py_ssize_t)strlen(PyString_AS_STRING(s))
1032 != size) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001033 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001034 return converterr(
1035 "(encoded string without NULL bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001036 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001037 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001038 *buffer = PyMem_NEW(char, size + 1);
1039 if (*buffer == NULL) {
1040 Py_DECREF(s);
1041 return converterr("(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001042 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001043 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001044 if(addcleanup(*buffer, freelist)) {
1045 Py_DECREF(s);
1046 return converterr("(cleanup problem)",
1047 arg, msgbuf, bufsize);
1048 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001049 memcpy(*buffer,
1050 PyString_AS_STRING(s),
1051 size + 1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001052 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001053 Py_DECREF(s);
1054 break;
1055 }
1056
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001057#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001058 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1059 if (*format == '#') { /* any buffer-like object */
1060 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001061 FETCH_SIZE;
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001062 if (PyUnicode_Check(arg)) {
1063 *p = PyUnicode_AS_UNICODE(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001064 STORE_SIZE(PyUnicode_GET_SIZE(arg));
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001065 }
1066 else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001067 return converterr("cannot convert raw buffers",
1068 arg, msgbuf, bufsize);
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001069 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001070 format++;
1071 } else {
1072 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossume826ef02000-03-10 23:02:17 +00001073 if (PyUnicode_Check(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001074 *p = PyUnicode_AS_UNICODE(arg);
1075 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001076 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001077 }
1078 break;
1079 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001080#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001081
1082 case 'S': { /* string object */
1083 PyObject **p = va_arg(*p_va, PyObject **);
Guido van Rossum572dbf82007-04-27 23:53:51 +00001084 if (PyString_Check(arg) || PyUnicode_Check(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001085 *p = arg;
1086 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001087 return converterr("string", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001088 break;
1089 }
1090
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001091#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001092 case 'U': { /* Unicode object */
1093 PyObject **p = va_arg(*p_va, PyObject **);
1094 if (PyUnicode_Check(arg))
1095 *p = arg;
1096 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001097 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001098 break;
1099 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001100#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001101
1102 case 'O': { /* object */
1103 PyTypeObject *type;
1104 PyObject **p;
1105 if (*format == '!') {
1106 type = va_arg(*p_va, PyTypeObject*);
1107 p = va_arg(*p_va, PyObject **);
1108 format++;
Guido van Rossumcbfc8552001-08-28 16:37:51 +00001109 if (PyType_IsSubtype(arg->ob_type, type))
Guido van Rossume826ef02000-03-10 23:02:17 +00001110 *p = arg;
1111 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001112 return converterr(type->tp_name, arg, msgbuf, bufsize);
Guido van Rossumfccfe891998-05-15 22:04:07 +00001113
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001114 }
1115 else if (*format == '?') {
1116 inquiry pred = va_arg(*p_va, inquiry);
1117 p = va_arg(*p_va, PyObject **);
1118 format++;
1119 if ((*pred)(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001120 *p = arg;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001121 else
1122 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001123 arg, msgbuf, bufsize);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001124
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001125 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001126 else if (*format == '&') {
1127 typedef int (*converter)(PyObject *, void *);
1128 converter convert = va_arg(*p_va, converter);
1129 void *addr = va_arg(*p_va, void *);
1130 format++;
1131 if (! (*convert)(arg, addr))
1132 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001133 arg, msgbuf, bufsize);
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001134 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001135 else {
1136 p = va_arg(*p_va, PyObject **);
1137 *p = arg;
1138 }
1139 break;
1140 }
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001141
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001142
1143 case 'w': { /* memory buffer, read-write access */
1144 void **p = va_arg(*p_va, void **);
1145 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1146 int count;
1147
1148 if (pb == NULL ||
1149 pb->bf_getwritebuffer == NULL ||
1150 pb->bf_getsegcount == NULL)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001151 return converterr("read-write buffer", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001152 if ((*pb->bf_getsegcount)(arg, NULL) != 1)
1153 return converterr("single-segment read-write buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001154 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001155 if ((count = pb->bf_getwritebuffer(arg, 0, p)) < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001156 return converterr("(unspecified)", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001157 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001158 FETCH_SIZE;
1159 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001160 format++;
1161 }
1162 break;
1163 }
1164
1165 case 't': { /* 8-bit character buffer, read-only access */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001166 char **p = va_arg(*p_va, char **);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001167 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001168 int count;
1169
1170 if (*format++ != '#')
1171 return converterr(
1172 "invalid use of 't' format character",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001173 arg, msgbuf, bufsize);
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001174 if (pb == NULL || pb->bf_getcharbuffer == NULL ||
Jeremy Hylton4819e972001-10-11 14:40:37 +00001175 pb->bf_getsegcount == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001176 return converterr(
1177 "string or read-only character buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001178 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001179
Jeremy Hylton4819e972001-10-11 14:40:37 +00001180 if (pb->bf_getsegcount(arg, NULL) != 1)
1181 return converterr(
1182 "string or single-segment read-only buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001183 arg, msgbuf, bufsize);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001184
1185 count = pb->bf_getcharbuffer(arg, 0, p);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001186 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001187 return converterr("(unspecified)", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001188 {
1189 FETCH_SIZE;
1190 STORE_SIZE(count);
1191 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001192 break;
1193 }
1194
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001195 default:
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001196 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001197
1198 }
1199
1200 *p_format = format;
1201 return NULL;
1202}
Guido van Rossumaa354651996-08-19 19:32:04 +00001203
Martin v. Löwis18e16552006-02-15 17:27:45 +00001204static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001205convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001206{
1207 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001208 Py_ssize_t count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001209 if (pb == NULL ||
1210 pb->bf_getreadbuffer == NULL ||
1211 pb->bf_getsegcount == NULL) {
1212 *errmsg = "string or read-only buffer";
1213 return -1;
1214 }
1215 if ((*pb->bf_getsegcount)(arg, NULL) != 1) {
1216 *errmsg = "string or single-segment read-only buffer";
1217 return -1;
1218 }
1219 if ((count = (*pb->bf_getreadbuffer)(arg, 0, p)) < 0) {
1220 *errmsg = "(unspecified)";
1221 }
1222 return count;
1223}
Guido van Rossumaa354651996-08-19 19:32:04 +00001224
1225/* Support for keyword arguments donated by
1226 Geoff Philbrick <philbric@delphi.hks.com> */
1227
Tim Petersf8cd3e82001-10-27 04:26:57 +00001228/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001229int
1230PyArg_ParseTupleAndKeywords(PyObject *args,
1231 PyObject *keywords,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001232 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001233 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001234{
1235 int retval;
1236 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001237
1238 if ((args == NULL || !PyTuple_Check(args)) ||
1239 (keywords != NULL && !PyDict_Check(keywords)) ||
1240 format == NULL ||
1241 kwlist == NULL)
1242 {
1243 PyErr_BadInternalCall();
Tim Petersf8cd3e82001-10-27 04:26:57 +00001244 return 0;
Tim Peters45772cd2001-10-27 03:58:40 +00001245 }
1246
Guido van Rossumaa354651996-08-19 19:32:04 +00001247 va_start(va, kwlist);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001248 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1249 va_end(va);
1250 return retval;
1251}
1252
1253int
1254_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1255 PyObject *keywords,
1256 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001257 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001258{
1259 int retval;
1260 va_list va;
1261
1262 if ((args == NULL || !PyTuple_Check(args)) ||
1263 (keywords != NULL && !PyDict_Check(keywords)) ||
1264 format == NULL ||
1265 kwlist == NULL)
1266 {
1267 PyErr_BadInternalCall();
1268 return 0;
1269 }
1270
1271 va_start(va, kwlist);
1272 retval = vgetargskeywords(args, keywords, format,
1273 kwlist, &va, FLAG_SIZE_T);
Guido van Rossumaa354651996-08-19 19:32:04 +00001274 va_end(va);
1275 return retval;
1276}
1277
1278
Brett Cannon711e7d92004-07-10 22:20:32 +00001279int
1280PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001281 PyObject *keywords,
1282 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001283 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001284{
1285 int retval;
1286 va_list lva;
1287
1288 if ((args == NULL || !PyTuple_Check(args)) ||
1289 (keywords != NULL && !PyDict_Check(keywords)) ||
1290 format == NULL ||
1291 kwlist == NULL)
1292 {
1293 PyErr_BadInternalCall();
1294 return 0;
1295 }
1296
1297#ifdef VA_LIST_IS_ARRAY
1298 memcpy(lva, va, sizeof(va_list));
1299#else
1300#ifdef __va_copy
1301 __va_copy(lva, va);
1302#else
1303 lva = va;
1304#endif
1305#endif
1306
Martin v. Löwis18e16552006-02-15 17:27:45 +00001307 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1308 return retval;
1309}
1310
1311int
1312_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1313 PyObject *keywords,
1314 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001315 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001316{
1317 int retval;
1318 va_list lva;
1319
1320 if ((args == NULL || !PyTuple_Check(args)) ||
1321 (keywords != NULL && !PyDict_Check(keywords)) ||
1322 format == NULL ||
1323 kwlist == NULL)
1324 {
1325 PyErr_BadInternalCall();
1326 return 0;
1327 }
1328
1329#ifdef VA_LIST_IS_ARRAY
1330 memcpy(lva, va, sizeof(va_list));
1331#else
1332#ifdef __va_copy
1333 __va_copy(lva, va);
1334#else
1335 lva = va;
1336#endif
1337#endif
1338
1339 retval = vgetargskeywords(args, keywords, format,
1340 kwlist, &lva, FLAG_SIZE_T);
Brett Cannon711e7d92004-07-10 22:20:32 +00001341 return retval;
1342}
1343
1344
Guido van Rossumaa354651996-08-19 19:32:04 +00001345static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001346vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001347 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001348{
Tim Petersdc5eff92001-10-27 06:53:00 +00001349 char msgbuf[512];
Guido van Rossumaa354651996-08-19 19:32:04 +00001350 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001351 const char *fname, *message;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001352 int min, max;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001353 const char *formatsave;
Tim Petersb639d492001-10-27 07:00:56 +00001354 int i, len, nargs, nkeywords;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001355 const char *msg;
1356 char **p;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001357 PyObject *freelist = NULL;
Tim Petersf4331c12001-10-27 00:17:34 +00001358
Tim Peters45772cd2001-10-27 03:58:40 +00001359 assert(args != NULL && PyTuple_Check(args));
1360 assert(keywords == NULL || PyDict_Check(keywords));
1361 assert(format != NULL);
1362 assert(kwlist != NULL);
1363 assert(p_va != NULL);
1364
Tim Petersf8cd3e82001-10-27 04:26:57 +00001365 /* Search the format:
1366 message <- error msg, if any (else NULL).
Tim Peterscffed4b2001-11-29 03:26:37 +00001367 fname <- routine name, if any (else NULL).
Tim Petersf8cd3e82001-10-27 04:26:57 +00001368 min <- # of required arguments, or -1 if all are required.
1369 max <- most arguments (required + optional).
Tim Peters62d48e12001-10-27 06:42:16 +00001370 Check that kwlist has a non-NULL entry for each arg.
Tim Petersf8cd3e82001-10-27 04:26:57 +00001371 Raise error if a tuple arg spec is found.
1372 */
1373 fname = message = NULL;
Tim Peters6fb26352001-10-27 04:38:11 +00001374 formatsave = format;
Tim Peters62d48e12001-10-27 06:42:16 +00001375 p = kwlist;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001376 min = -1;
1377 max = 0;
1378 while ((i = *format++) != '\0') {
Neal Norwitz30b5c5d2005-12-19 06:05:18 +00001379 if (isalpha(Py_CHARMASK(i)) && i != 'e') {
Tim Petersf8cd3e82001-10-27 04:26:57 +00001380 max++;
Tim Peters62d48e12001-10-27 06:42:16 +00001381 if (*p == NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001382 PyErr_SetString(PyExc_RuntimeError,
1383 "more argument specifiers than "
1384 "keyword list entries");
Tim Peters62d48e12001-10-27 06:42:16 +00001385 return 0;
1386 }
1387 p++;
1388 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001389 else if (i == '|')
1390 min = max;
1391 else if (i == ':') {
1392 fname = format;
1393 break;
1394 }
1395 else if (i == ';') {
1396 message = format;
1397 break;
1398 }
1399 else if (i == '(') {
Tim Peterscffed4b2001-11-29 03:26:37 +00001400 PyErr_SetString(PyExc_RuntimeError,
1401 "tuple found in format when using keyword "
1402 "arguments");
Guido van Rossumaa354651996-08-19 19:32:04 +00001403 return 0;
1404 }
Tim Peters62d48e12001-10-27 06:42:16 +00001405 }
1406 format = formatsave;
1407 if (*p != NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001408 PyErr_SetString(PyExc_RuntimeError,
1409 "more keyword list entries than "
1410 "argument specifiers");
Tim Peters62d48e12001-10-27 06:42:16 +00001411 return 0;
1412 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001413 if (min < 0) {
1414 /* All arguments are required. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001415 min = max;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001416 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001417
Tim Peters6fb26352001-10-27 04:38:11 +00001418 nargs = PyTuple_GET_SIZE(args);
Tim Petersb0872fc2001-10-27 04:45:34 +00001419 nkeywords = keywords == NULL ? 0 : PyDict_Size(keywords);
Tim Petersf8cd3e82001-10-27 04:26:57 +00001420
Guido van Rossumaa354651996-08-19 19:32:04 +00001421 /* make sure there are no duplicate values for an argument;
1422 its not clear when to use the term "keyword argument vs.
1423 keyword parameter in messages */
Tim Petersb054be42001-10-27 05:07:41 +00001424 if (nkeywords > 0) {
Tim Peters6fb26352001-10-27 04:38:11 +00001425 for (i = 0; i < nargs; i++) {
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001426 const char *thiskw = kwlist[i];
Tim Petersa9f47392001-10-27 00:46:09 +00001427 if (thiskw == NULL)
1428 break;
Tim Peters077f5742001-10-27 05:50:39 +00001429 if (PyDict_GetItemString(keywords, thiskw)) {
Tim Petersb054be42001-10-27 05:07:41 +00001430 PyErr_Format(PyExc_TypeError,
1431 "keyword parameter '%s' was given "
1432 "by position and by name",
Tim Petersa9f47392001-10-27 00:46:09 +00001433 thiskw);
Guido van Rossumaa354651996-08-19 19:32:04 +00001434 return 0;
1435 }
Tim Peters0af49162001-10-27 06:14:32 +00001436 else if (PyErr_Occurred())
1437 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001438 }
1439 }
Tim Peters61dde632001-10-27 05:30:17 +00001440
Guido van Rossumaa354651996-08-19 19:32:04 +00001441 /* required arguments missing from args can be supplied by keyword
Georg Brandld7048172006-01-20 17:53:27 +00001442 arguments; set len to the number of positional arguments, and,
Tim Peters62d48e12001-10-27 06:42:16 +00001443 if that's less than the minimum required, add in the number of
1444 required arguments that are supplied by keywords */
Tim Peters6fb26352001-10-27 04:38:11 +00001445 len = nargs;
Tim Peters62d48e12001-10-27 06:42:16 +00001446 if (nkeywords > 0 && nargs < min) {
Tim Peters6fb26352001-10-27 04:38:11 +00001447 for (i = nargs; i < min; i++) {
Tim Peters077f5742001-10-27 05:50:39 +00001448 if (PyDict_GetItemString(keywords, kwlist[i]))
Guido van Rossumaa354651996-08-19 19:32:04 +00001449 len++;
Tim Peters0af49162001-10-27 06:14:32 +00001450 else if (PyErr_Occurred())
1451 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001452 }
1453 }
Tim Peters0af49162001-10-27 06:14:32 +00001454
Guido van Rossumaa354651996-08-19 19:32:04 +00001455 /* make sure we got an acceptable number of arguments; the message
1456 is a little confusing with keywords since keyword arguments
1457 which are supplied, but don't match the required arguments
Michael W. Hudson5253c302005-03-30 16:41:55 +00001458 are not included in the "%d given" part of the message
1459 XXX and this isn't a bug!? */
Guido van Rossumaa354651996-08-19 19:32:04 +00001460 if (len < min || max < len) {
1461 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +00001462 PyOS_snprintf(msgbuf, sizeof(msgbuf),
1463 "%.200s%s takes %s %d argument%s "
1464 "(%d given)",
1465 fname==NULL ? "function" : fname,
1466 fname==NULL ? "" : "()",
1467 min==max ? "exactly"
1468 : len < min ? "at least" : "at most",
1469 len < min ? min : max,
1470 (len < min ? min : max) == 1 ? "" : "s",
1471 len);
Guido van Rossumaa354651996-08-19 19:32:04 +00001472 message = msgbuf;
1473 }
1474 PyErr_SetString(PyExc_TypeError, message);
1475 return 0;
1476 }
Tim Petersc2f01122001-10-27 07:25:06 +00001477
1478 /* convert the positional arguments */
Tim Peters6fb26352001-10-27 04:38:11 +00001479 for (i = 0; i < nargs; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001480 if (*format == '|')
1481 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +00001482 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001483 flags, levels, msgbuf, sizeof(msgbuf),
1484 &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001485 if (msg) {
1486 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001487 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001488 }
1489 }
1490
Tim Petersc2f01122001-10-27 07:25:06 +00001491 /* handle no keyword parameters in call */
Tim Petersb054be42001-10-27 05:07:41 +00001492 if (nkeywords == 0)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001493 return cleanreturn(1, freelist);
Tim Petersb054be42001-10-27 05:07:41 +00001494
Guido van Rossumaa354651996-08-19 19:32:04 +00001495 /* convert the keyword arguments; this uses the format
1496 string where it was left after processing args */
Tim Petersb639d492001-10-27 07:00:56 +00001497 for (i = nargs; i < max; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001498 PyObject *item;
Guido van Rossumaa354651996-08-19 19:32:04 +00001499 if (*format == '|')
1500 format++;
Tim Peters077f5742001-10-27 05:50:39 +00001501 item = PyDict_GetItemString(keywords, kwlist[i]);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001502 if (item != NULL) {
Tim Peters077f5742001-10-27 05:50:39 +00001503 Py_INCREF(item);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001504 msg = convertitem(item, &format, p_va, flags, levels,
1505 msgbuf, sizeof(msgbuf), &freelist);
Tim Peters077f5742001-10-27 05:50:39 +00001506 Py_DECREF(item);
Guido van Rossumaa354651996-08-19 19:32:04 +00001507 if (msg) {
1508 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001509 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001510 }
Tim Petersc2f01122001-10-27 07:25:06 +00001511 --nkeywords;
1512 if (nkeywords == 0)
1513 break;
Guido van Rossumaa354651996-08-19 19:32:04 +00001514 }
Tim Peters0af49162001-10-27 06:14:32 +00001515 else if (PyErr_Occurred())
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001516 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001517 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001518 msg = skipitem(&format, p_va, flags);
Guido van Rossumaa354651996-08-19 19:32:04 +00001519 if (msg) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001520 levels[0] = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001521 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001522 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001523 }
1524 }
1525 }
Tim Petersb054be42001-10-27 05:07:41 +00001526
Guido van Rossumaa354651996-08-19 19:32:04 +00001527 /* make sure there are no extraneous keyword arguments */
Tim Petersc2f01122001-10-27 07:25:06 +00001528 if (nkeywords > 0) {
1529 PyObject *key, *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001530 Py_ssize_t pos = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001531 while (PyDict_Next(keywords, &pos, &key, &value)) {
Tim Petersc2f01122001-10-27 07:25:06 +00001532 int match = 0;
Guido van Rossum55474762002-04-04 16:22:30 +00001533 char *ks;
Guido van Rossum572dbf82007-04-27 23:53:51 +00001534 if (!PyString_Check(key) && !PyUnicode_Check(key)) {
Guido van Rossum55474762002-04-04 16:22:30 +00001535 PyErr_SetString(PyExc_TypeError,
1536 "keywords must be strings");
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001537 return cleanreturn(0, freelist);
Guido van Rossum55474762002-04-04 16:22:30 +00001538 }
1539 ks = PyString_AsString(key);
Tim Petersb639d492001-10-27 07:00:56 +00001540 for (i = 0; i < max; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001541 if (!strcmp(ks, kwlist[i])) {
1542 match = 1;
1543 break;
1544 }
1545 }
1546 if (!match) {
Tim Petersc2f01122001-10-27 07:25:06 +00001547 PyErr_Format(PyExc_TypeError,
1548 "'%s' is an invalid keyword "
1549 "argument for this function",
1550 ks);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001551 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001552 }
1553 }
1554 }
Tim Petersc2f01122001-10-27 07:25:06 +00001555
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001556 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001557}
1558
1559
1560static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001561skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001562{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001563 const char *format = *p_format;
Guido van Rossumaa354651996-08-19 19:32:04 +00001564 char c = *format++;
1565
1566 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001567
1568 /* simple codes
1569 * The individual types (second arg of va_arg) are irrelevant */
1570
Guido van Rossumaa354651996-08-19 19:32:04 +00001571 case 'b': /* byte -- very short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001572 case 'B': /* byte as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001573 case 'h': /* short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001574 case 'H': /* short int as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001575 case 'i': /* int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001576 case 'I': /* int sized bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001577 case 'l': /* long int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001578 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001579#ifdef HAVE_LONG_LONG
Georg Brandl6dd14612005-09-14 19:29:53 +00001580 case 'L': /* PY_LONG_LONG */
1581 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001582#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001583 case 'f': /* float */
Guido van Rossumaa354651996-08-19 19:32:04 +00001584 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001585#ifndef WITHOUT_COMPLEX
1586 case 'D': /* complex double */
Georg Brandl6dd14612005-09-14 19:29:53 +00001587#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001588 case 'c': /* char */
1589 {
Georg Brandl6dd14612005-09-14 19:29:53 +00001590 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001591 break;
1592 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001593
1594 case 'n': /* Py_ssize_t */
1595 {
1596 (void) va_arg(*p_va, Py_ssize_t *);
1597 break;
1598 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001599
Georg Brandl6dd14612005-09-14 19:29:53 +00001600 /* string codes */
1601
1602 case 'e': /* string with encoding */
1603 {
1604 (void) va_arg(*p_va, const char *);
1605 if (!(*format == 's' || *format == 't'))
1606 /* after 'e', only 's' and 't' is allowed */
1607 goto err;
1608 format++;
1609 /* explicit fallthrough to string cases */
1610 }
1611
Guido van Rossumaa354651996-08-19 19:32:04 +00001612 case 's': /* string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001613 case 'z': /* string or None */
1614#ifdef Py_USING_UNICODE
1615 case 'u': /* unicode string */
1616#endif
1617 case 't': /* buffer, read-only */
1618 case 'w': /* buffer, read-write */
Guido van Rossumaa354651996-08-19 19:32:04 +00001619 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001620 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001621 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001622 if (flags & FLAG_SIZE_T)
1623 (void) va_arg(*p_va, Py_ssize_t *);
1624 else
1625 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001626 format++;
1627 }
1628 break;
1629 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001630
1631 /* object codes */
1632
Guido van Rossumaa354651996-08-19 19:32:04 +00001633 case 'S': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001634#ifdef Py_USING_UNICODE
1635 case 'U': /* unicode string object */
1636#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001637 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001638 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001639 break;
1640 }
1641
1642 case 'O': /* object */
1643 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001644 if (*format == '!') {
1645 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001646 (void) va_arg(*p_va, PyTypeObject*);
1647 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001648 }
1649#if 0
1650/* I don't know what this is for */
1651 else if (*format == '?') {
1652 inquiry pred = va_arg(*p_va, inquiry);
1653 format++;
1654 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001655 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001656 }
1657 }
1658#endif
1659 else if (*format == '&') {
Tim Petersdbd9ba62000-07-09 03:09:57 +00001660 typedef int (*converter)(PyObject *, void *);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001661 (void) va_arg(*p_va, converter);
1662 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001663 format++;
1664 }
1665 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001666 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001667 }
1668 break;
1669 }
1670
1671 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001672err:
Guido van Rossumaa354651996-08-19 19:32:04 +00001673 return "impossible<bad format char>";
1674
1675 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001676
1677 /* The "(...)" format code for tuples is not handled here because
1678 * it is not allowed with keyword args. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001679
1680 *p_format = format;
1681 return NULL;
1682}
Fred Drakee4616e62001-10-23 21:09:29 +00001683
1684
1685int
Martin v. Löwis76246742006-03-01 04:06:10 +00001686PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001687{
Martin v. Löwis76246742006-03-01 04:06:10 +00001688 Py_ssize_t i, l;
Fred Drakee4616e62001-10-23 21:09:29 +00001689 PyObject **o;
1690 va_list vargs;
1691
1692#ifdef HAVE_STDARG_PROTOTYPES
1693 va_start(vargs, max);
1694#else
1695 va_start(vargs);
1696#endif
1697
1698 assert(min >= 0);
1699 assert(min <= max);
1700 if (!PyTuple_Check(args)) {
1701 PyErr_SetString(PyExc_SystemError,
1702 "PyArg_UnpackTuple() argument list is not a tuple");
1703 return 0;
1704 }
1705 l = PyTuple_GET_SIZE(args);
1706 if (l < min) {
1707 if (name != NULL)
1708 PyErr_Format(
1709 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001710 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001711 name, (min == max ? "" : "at least "), min, l);
1712 else
1713 PyErr_Format(
1714 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001715 "unpacked tuple should have %s%zd elements,"
1716 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001717 (min == max ? "" : "at least "), min, l);
1718 va_end(vargs);
1719 return 0;
1720 }
1721 if (l > max) {
1722 if (name != NULL)
1723 PyErr_Format(
1724 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001725 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001726 name, (min == max ? "" : "at most "), max, l);
1727 else
1728 PyErr_Format(
1729 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001730 "unpacked tuple should have %s%zd elements,"
1731 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001732 (min == max ? "" : "at most "), max, l);
1733 va_end(vargs);
1734 return 0;
1735 }
1736 for (i = 0; i < l; i++) {
1737 o = va_arg(vargs, PyObject **);
1738 *o = PyTuple_GET_ITEM(args, i);
1739 }
1740 va_end(vargs);
1741 return 1;
1742}
Georg Brandl02c42872005-08-26 06:42:30 +00001743
1744
1745/* For type constructors that don't take keyword args
1746 *
1747 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001748 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001749 */
1750int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001751_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001752{
1753 if (kw == NULL)
1754 return 1;
1755 if (!PyDict_CheckExact(kw)) {
1756 PyErr_BadInternalCall();
1757 return 0;
1758 }
1759 if (PyDict_Size(kw) == 0)
1760 return 1;
1761
1762 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1763 funcname);
1764 return 0;
1765}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001766#ifdef __cplusplus
1767};
1768#endif