blob: fac0b6fdef2de2e17343042d07a3093b7ed1f29f [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
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00009int PyArg_Parse(PyObject *, const char *, ...);
10int PyArg_ParseTuple(PyObject *, const char *, ...);
11int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000012
Tim Petersdbd9ba62000-07-09 03:09:57 +000013int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000014 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000015int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000016 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000017
Martin v. Löwis18e16552006-02-15 17:27:45 +000018#define FLAG_COMPAT 1
19#define FLAG_SIZE_T 2
20
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000021
22/* Forward */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000023static int vgetargs1(PyObject *, const char *, va_list *, int);
24static void seterror(int, const char *, int *, const char *, const char *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000025static char *convertitem(PyObject *, const char **, va_list *, int, int *,
26 char *, size_t, PyObject **);
27static char *converttuple(PyObject *, const char **, va_list *, int,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +000028 int *, char *, size_t, int, PyObject **);
Martin v. Löwis18e16552006-02-15 17:27:45 +000029static char *convertsimple(PyObject *, const char **, va_list *, int, char *,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +000030 size_t, PyObject **);
Martin v. Löwis18e16552006-02-15 17:27:45 +000031static Py_ssize_t convertbuffer(PyObject *, void **p, char **);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000032
Tim Petersdbd9ba62000-07-09 03:09:57 +000033static int vgetargskeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000034 const char *, char **, va_list *, int);
Martin v. Löwis18e16552006-02-15 17:27:45 +000035static char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000036
Fred Drake563dfc22001-10-23 14:41:08 +000037int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000038PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000039{
40 int retval;
41 va_list va;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000042
43 va_start(va, format);
Martin v. Löwis18e16552006-02-15 17:27:45 +000044 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
45 va_end(va);
46 return retval;
47}
48
49int
50_PyArg_Parse_SizeT(PyObject *args, char *format, ...)
51{
52 int retval;
53 va_list va;
54
55 va_start(va, format);
56 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000057 va_end(va);
58 return retval;
59}
60
61
Fred Drake563dfc22001-10-23 14:41:08 +000062int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000063PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000064{
65 int retval;
66 va_list va;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000067
68 va_start(va, format);
Guido van Rossum1ae940a1995-01-02 19:04:15 +000069 retval = vgetargs1(args, format, &va, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000070 va_end(va);
71 return retval;
72}
73
Martin v. Löwis18e16552006-02-15 17:27:45 +000074int
75_PyArg_ParseTuple_SizeT(PyObject *args, char *format, ...)
76{
77 int retval;
78 va_list va;
79
80 va_start(va, format);
81 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
82 va_end(va);
83 return retval;
84}
85
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000086
87int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000088PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000089{
Guido van Rossum1ae940a1995-01-02 19:04:15 +000090 va_list lva;
91
92#ifdef VA_LIST_IS_ARRAY
93 memcpy(lva, va, sizeof(va_list));
94#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +000095#ifdef __va_copy
96 __va_copy(lva, va);
97#else
Guido van Rossum1ae940a1995-01-02 19:04:15 +000098 lva = va;
99#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000100#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000101
102 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000103}
104
Martin v. Löwis18e16552006-02-15 17:27:45 +0000105int
106_PyArg_VaParse_SizeT(PyObject *args, char *format, va_list va)
107{
108 va_list lva;
109
110#ifdef VA_LIST_IS_ARRAY
111 memcpy(lva, va, sizeof(va_list));
112#else
113#ifdef __va_copy
114 __va_copy(lva, va);
115#else
116 lva = va;
117#endif
118#endif
119
120 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
121}
122
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000123
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000124/* Handle cleanup of allocated memory in case of exception */
125
126static int
127addcleanup(void *ptr, PyObject **freelist)
128{
129 PyObject *cobj;
130 if (!*freelist) {
131 *freelist = PyList_New(0);
132 if (!*freelist) {
133 PyMem_FREE(ptr);
134 return -1;
135 }
136 }
137 cobj = PyCObject_FromVoidPtr(ptr, NULL);
138 if (!cobj) {
139 PyMem_FREE(ptr);
140 return -1;
141 }
142 if(PyList_Append(*freelist, cobj)) {
143 PyMem_FREE(ptr);
144 Py_DECREF(cobj);
145 return -1;
146 }
147 Py_DECREF(cobj);
148 return 0;
149}
150
151static int
152cleanreturn(int retval, PyObject *freelist)
153{
154 if(freelist) {
155 if((retval) == 0) {
Martin v. Löwisd96ee902006-02-16 14:37:16 +0000156 Py_ssize_t len = PyList_GET_SIZE(freelist), i;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000157 for (i = 0; i < len; i++)
158 PyMem_FREE(PyCObject_AsVoidPtr(
159 PyList_GET_ITEM(freelist, i)));
160 }
161 Py_DECREF(freelist);
162 }
163 return retval;
164}
165
166
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000167static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000168vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000169{
170 char msgbuf[256];
171 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000172 const char *fname = NULL;
173 const char *message = NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000174 int min = -1;
175 int max = 0;
176 int level = 0;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000177 int endfmt = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000178 const char *formatsave = format;
Martin v. Löwisd96ee902006-02-16 14:37:16 +0000179 Py_ssize_t i, len;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000180 char *msg;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000181 PyObject *freelist = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000182 int compat = flags & FLAG_COMPAT;
183
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000184 assert(compat || (args != (PyObject*)NULL));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000185 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000186
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000187 while (endfmt == 0) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000188 int c = *format++;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000189 switch (c) {
190 case '(':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000191 if (level == 0)
192 max++;
193 level++;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000194 break;
195 case ')':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000196 if (level == 0)
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000197 Py_FatalError("excess ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000198 else
199 level--;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000200 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000201 case '\0':
202 endfmt = 1;
203 break;
204 case ':':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000205 fname = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000206 endfmt = 1;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000207 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000208 case ';':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000209 message = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000210 endfmt = 1;
211 break;
212 default:
213 if (level == 0) {
214 if (c == 'O')
215 max++;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000216 else if (isalpha(Py_CHARMASK(c))) {
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000217 if (c != 'e') /* skip encoded */
218 max++;
219 } else if (c == '|')
220 min = max;
221 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000222 break;
223 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000224 }
225
226 if (level != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000227 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000228
229 if (min < 0)
230 min = max;
231
232 format = formatsave;
233
234 if (compat) {
235 if (max == 0) {
236 if (args == NULL)
237 return 1;
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000238 PyOS_snprintf(msgbuf, sizeof(msgbuf),
239 "%.200s%s takes no arguments",
240 fname==NULL ? "function" : fname,
241 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000242 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000243 return 0;
244 }
245 else if (min == 1 && max == 1) {
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000246 if (args == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000247 PyOS_snprintf(msgbuf, sizeof(msgbuf),
248 "%.200s%s takes at least one argument",
249 fname==NULL ? "function" : fname,
250 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000251 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000252 return 0;
253 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000254 msg = convertitem(args, &format, p_va, flags, levels,
255 msgbuf, sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000256 if (msg == NULL)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000257 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000258 seterror(levels[0], msg, levels+1, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000259 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000260 }
261 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000262 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000263 "old style getargs format uses new features");
264 return 0;
265 }
266 }
267
Guido van Rossum79f25d91997-04-29 20:08:16 +0000268 if (!PyTuple_Check(args)) {
269 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000270 "new style getargs format but argument is not a tuple");
271 return 0;
272 }
273
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000274 len = PyTuple_GET_SIZE(args);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000275
276 if (len < min || max < len) {
277 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000278 PyOS_snprintf(msgbuf, sizeof(msgbuf),
279 "%.150s%s takes %s %d argument%s "
Neal Norwitz20dd93f2006-02-19 19:34:15 +0000280 "(%ld given)",
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000281 fname==NULL ? "function" : fname,
282 fname==NULL ? "" : "()",
283 min==max ? "exactly"
284 : len < min ? "at least" : "at most",
285 len < min ? min : max,
286 (len < min ? min : max) == 1 ? "" : "s",
Neal Norwitz9a276172006-02-20 18:57:39 +0000287 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000288 message = msgbuf;
289 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000290 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000291 return 0;
292 }
293
294 for (i = 0; i < len; i++) {
295 if (*format == '|')
296 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000297 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000298 flags, levels, msgbuf,
299 sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000300 if (msg) {
301 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000302 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000303 }
304 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000305
Neal Norwitz4ac13df2005-12-19 06:10:07 +0000306 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
Guido van Rossum7d4f68c1997-12-19 04:25:23 +0000307 *format != '(' &&
Guido van Rossum231a41e1997-12-09 20:36:39 +0000308 *format != '|' && *format != ':' && *format != ';') {
309 PyErr_Format(PyExc_SystemError,
Guido van Rossum0d6b49e1998-01-19 22:22:44 +0000310 "bad format string: %.200s", formatsave);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000311 return cleanreturn(0, freelist);
Guido van Rossum231a41e1997-12-09 20:36:39 +0000312 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000313
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000314 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000315}
316
317
318
319static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000320seterror(int iarg, const char *msg, int *levels, const char *fname,
321 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000322{
Marc-André Lemburgd4c0a9c2001-11-28 11:47:00 +0000323 char buf[512];
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000324 int i;
325 char *p = buf;
326
Guido van Rossum79f25d91997-04-29 20:08:16 +0000327 if (PyErr_Occurred())
Guido van Rossum64fc6491995-01-21 14:09:37 +0000328 return;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000329 else if (message == NULL) {
330 if (fname != NULL) {
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000331 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000332 p += strlen(p);
333 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000334 if (iarg != 0) {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000335 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000336 "argument %d", iarg);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000337 i = 0;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000338 p += strlen(p);
Marc-André Lemburgd4c0a9c2001-11-28 11:47:00 +0000339 while (levels[i] > 0 && (int)(p-buf) < 220) {
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000340 PyOS_snprintf(p, sizeof(buf) - (buf - p),
341 ", item %d", levels[i]-1);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000342 p += strlen(p);
343 i++;
344 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000345 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000346 else {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000347 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
Ka-Ping Yee20579702001-01-15 22:14:16 +0000348 p += strlen(p);
349 }
Tim Petersfaad5ad2001-12-03 00:43:33 +0000350 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000351 message = buf;
352 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000353 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000354}
355
356
357/* Convert a tuple argument.
358 On entry, *p_format points to the character _after_ the opening '('.
359 On successful exit, *p_format points to the closing ')'.
360 If successful:
361 *p_format and *p_va are updated,
362 *levels and *msgbuf are untouched,
363 and NULL is returned.
364 If the argument is invalid:
365 *p_format is unchanged,
366 *p_va is undefined,
367 *levels is a 0-terminated list of item numbers,
368 *msgbuf contains an error message, whose format is:
Ka-Ping Yee20579702001-01-15 22:14:16 +0000369 "must be <typename1>, not <typename2>", where:
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000370 <typename1> is the name of the expected type, and
371 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000372 and msgbuf is returned.
373*/
374
375static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000376converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
377 int *levels, char *msgbuf, size_t bufsize, int toplevel,
378 PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000379{
380 int level = 0;
381 int n = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000382 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000383 int i;
384
385 for (;;) {
386 int c = *format++;
387 if (c == '(') {
388 if (level == 0)
389 n++;
390 level++;
391 }
392 else if (c == ')') {
393 if (level == 0)
394 break;
395 level--;
396 }
397 else if (c == ':' || c == ';' || c == '\0')
398 break;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000399 else if (level == 0 && isalpha(Py_CHARMASK(c)))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000400 n++;
401 }
402
Ka-Ping Yee20579702001-01-15 22:14:16 +0000403 if (!PySequence_Check(arg) || PyString_Check(arg)) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000404 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000405 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000406 toplevel ? "expected %d arguments, not %.50s" :
407 "must be %d-item sequence, not %.50s",
408 n,
409 arg == Py_None ? "None" : arg->ob_type->tp_name);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000410 return msgbuf;
411 }
412
Jeremy Hylton03657cf2000-07-12 13:05:33 +0000413 if ((i = PySequence_Size(arg)) != n) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000414 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000415 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000416 toplevel ? "expected %d arguments, not %d" :
417 "must be sequence of length %d, not %d",
418 n, i);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000419 return msgbuf;
420 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000421
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000422 format = *p_format;
423 for (i = 0; i < n; i++) {
424 char *msg;
Guido van Rossum66368cc1999-02-17 23:16:43 +0000425 PyObject *item;
426 item = PySequence_GetItem(arg, i);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000427 msg = convertitem(item, &format, p_va, flags, levels+1,
428 msgbuf, bufsize, freelist);
Guido van Rossum66368cc1999-02-17 23:16:43 +0000429 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
430 Py_XDECREF(item);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000431 if (msg != NULL) {
432 levels[0] = i+1;
433 return msg;
434 }
435 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000436
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000437 *p_format = format;
438 return NULL;
439}
440
441
442/* Convert a single item. */
443
444static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000445convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
446 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000447{
448 char *msg;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000449 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000450
451 if (*format == '(' /* ')' */) {
452 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000453 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000454 bufsize, 0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000455 if (msg == NULL)
456 format++;
457 }
458 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000459 msg = convertsimple(arg, &format, p_va, flags,
460 msgbuf, bufsize, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000461 if (msg != NULL)
462 levels[0] = 0;
463 }
464 if (msg == NULL)
465 *p_format = format;
466 return msg;
467}
468
469
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000470
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000471#define UNICODE_DEFAULT_ENCODING(arg) \
472 _PyUnicode_AsDefaultEncodedString(arg, NULL)
473
474/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000475
476static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000477converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000478{
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000479 assert(expected != NULL);
480 assert(arg != NULL);
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000481 PyOS_snprintf(msgbuf, bufsize,
482 "must be %.50s, not %.50s", expected,
483 arg == Py_None ? "None" : arg->ob_type->tp_name);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000484 return msgbuf;
485}
486
487#define CONV_UNICODE "(unicode conversion error)"
488
Guido van Rossum45aecf42006-03-15 04:58:47 +0000489/* Explicitly check for float arguments when integers are expected.
490 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000491static int
492float_argument_error(PyObject *arg)
493{
Guido van Rossum45aecf42006-03-15 04:58:47 +0000494 if (PyFloat_Check(arg)) {
495 PyErr_SetString(PyExc_TypeError,
496 "integer argument expected, got float" );
Neil Schemenauer5042da62003-02-04 20:59:40 +0000497 return 1;
Guido van Rossum45aecf42006-03-15 04:58:47 +0000498 }
Neil Schemenauer5042da62003-02-04 20:59:40 +0000499 else
500 return 0;
501}
502
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000503/* Convert a non-tuple argument. Return NULL if conversion went OK,
504 or a string with a message describing the failure. The message is
505 formatted as "must be <desired type>, not <actual type>".
506 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000507 Don't call if a tuple is expected.
508
509 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000510*/
511
512static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000513convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000514 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000515{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000516 /* For # codes */
517#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
518 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
519 else q=va_arg(*p_va, int*);
520#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
521#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
522
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000523 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000524 char c = *format++;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000525#ifdef Py_USING_UNICODE
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000526 PyObject *uarg;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000527#endif
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000528
529 switch (c) {
530
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000531 case 'b': { /* unsigned byte -- very short int */
532 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000533 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000534 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000535 return converterr("integer<b>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000536 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000537 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000538 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000539 else if (ival < 0) {
540 PyErr_SetString(PyExc_OverflowError,
541 "unsigned byte integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000542 return converterr("integer<b>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000543 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000544 else if (ival > UCHAR_MAX) {
545 PyErr_SetString(PyExc_OverflowError,
546 "unsigned byte integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000547 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000548 }
549 else
550 *p = (unsigned char) ival;
551 break;
552 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000553
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000554 case 'B': {/* byte sized bitfield - both signed and unsigned
555 values allowed */
556 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000557 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000558 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000559 return converterr("integer<B>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000560 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000561 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000562 return converterr("integer<B>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000563 else
564 *p = (unsigned char) ival;
565 break;
566 }
Jack Jansencc22fbe2000-08-05 21:29:58 +0000567
Guido van Rossumfce26e72003-04-18 00:12:30 +0000568 case 'h': {/* signed short int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000569 short *p = va_arg(*p_va, short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000570 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000571 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000572 return converterr("integer<h>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000573 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000574 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000575 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfce26e72003-04-18 00:12:30 +0000576 else if (ival < SHRT_MIN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000577 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000578 "signed short integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000579 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000580 }
Guido van Rossumfce26e72003-04-18 00:12:30 +0000581 else if (ival > SHRT_MAX) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000582 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000583 "signed short integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000584 return converterr("integer<h>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000585 }
586 else
587 *p = (short) ival;
588 break;
589 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000590
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000591 case 'H': { /* short int sized bitfield, both signed and
592 unsigned allowed */
593 unsigned short *p = va_arg(*p_va, unsigned short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000594 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000595 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000596 return converterr("integer<H>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000597 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000598 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000599 return converterr("integer<H>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000600 else
601 *p = (unsigned short) ival;
602 break;
603 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000604
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000605 case 'i': {/* signed int */
606 int *p = va_arg(*p_va, int *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000607 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000608 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000609 return converterr("integer<i>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000610 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000611 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000612 return converterr("integer<i>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000613 else if (ival > INT_MAX) {
614 PyErr_SetString(PyExc_OverflowError,
615 "signed integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000616 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000617 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000618 else if (ival < INT_MIN) {
619 PyErr_SetString(PyExc_OverflowError,
620 "signed integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000621 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000622 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000623 else
624 *p = ival;
625 break;
626 }
627
Thomas Hellera4ea6032003-04-17 18:55:45 +0000628 case 'I': { /* int sized bitfield, both signed and
629 unsigned allowed */
630 unsigned int *p = va_arg(*p_va, unsigned int *);
631 unsigned int ival;
632 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000633 return converterr("integer<I>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000634 ival = PyInt_AsUnsignedLongMask(arg);
635 if (ival == -1 && PyErr_Occurred())
636 return converterr("integer<I>", arg, msgbuf, bufsize);
637 else
638 *p = ival;
639 break;
640 }
641
Martin v. Löwis18e16552006-02-15 17:27:45 +0000642 case 'n': /* Py_ssize_t */
643#if SIZEOF_SIZE_T != SIZEOF_LONG
644 {
645 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
646 Py_ssize_t ival;
647 if (float_argument_error(arg))
648 return converterr("integer<i>", arg, msgbuf, bufsize);
649 ival = PyInt_AsSsize_t(arg);
650 if (ival == -1 && PyErr_Occurred())
651 return converterr("integer<i>", arg, msgbuf, bufsize);
652 *p = ival;
653 break;
654 }
655#endif
656 /* Fall through from 'n' to 'l' if Py_ssize_t is int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000657 case 'l': {/* long int */
658 long *p = va_arg(*p_va, long *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000659 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000660 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000661 return converterr("integer<l>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000662 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000663 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000664 return converterr("integer<l>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000665 else
666 *p = ival;
667 break;
668 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000669
670 case 'k': { /* long sized bitfield */
671 unsigned long *p = va_arg(*p_va, unsigned long *);
672 unsigned long ival;
673 if (PyInt_Check(arg))
674 ival = PyInt_AsUnsignedLongMask(arg);
675 else if (PyLong_Check(arg))
676 ival = PyLong_AsUnsignedLongMask(arg);
677 else
678 return converterr("integer<k>", arg, msgbuf, bufsize);
679 *p = ival;
680 break;
681 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000682
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000683#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000684 case 'L': {/* PY_LONG_LONG */
685 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
686 PY_LONG_LONG ival = PyLong_AsLongLong( arg );
687 if( ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000688 return converterr("long<L>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000689 } else {
690 *p = ival;
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000691 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000692 break;
693 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000694
695 case 'K': { /* long long sized bitfield */
696 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
697 unsigned PY_LONG_LONG ival;
Thomas Hellera4ea6032003-04-17 18:55:45 +0000698 if (PyInt_Check(arg))
699 ival = PyInt_AsUnsignedLongMask(arg);
700 else if (PyLong_Check(arg))
701 ival = PyLong_AsUnsignedLongLongMask(arg);
702 else
703 return converterr("integer<K>", arg, msgbuf, bufsize);
704 *p = ival;
705 break;
706 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000707#endif
708
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000709 case 'f': {/* float */
710 float *p = va_arg(*p_va, float *);
711 double dval = PyFloat_AsDouble(arg);
712 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000713 return converterr("float<f>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000714 else
715 *p = (float) dval;
716 break;
717 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000718
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000719 case 'd': {/* double */
720 double *p = va_arg(*p_va, double *);
721 double dval = PyFloat_AsDouble(arg);
722 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000723 return converterr("float<d>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000724 else
725 *p = dval;
726 break;
727 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000728
Guido van Rossum530956d1996-07-21 02:27:43 +0000729#ifndef WITHOUT_COMPLEX
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000730 case 'D': {/* complex double */
731 Py_complex *p = va_arg(*p_va, Py_complex *);
732 Py_complex cval;
733 cval = PyComplex_AsCComplex(arg);
734 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000735 return converterr("complex<D>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000736 else
737 *p = cval;
738 break;
739 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000740#endif /* WITHOUT_COMPLEX */
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000741
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000742 case 'c': {/* char */
743 char *p = va_arg(*p_va, char *);
744 if (PyString_Check(arg) && PyString_Size(arg) == 1)
Jeremy Hylton0407aea2001-10-10 02:51:57 +0000745 *p = PyString_AS_STRING(arg)[0];
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000746 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000747 return converterr("char", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000748 break;
749 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000750
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000751 case 's': {/* string */
752 if (*format == '#') {
753 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000754 FETCH_SIZE;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000755
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000756 if (PyString_Check(arg)) {
757 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000758 STORE_SIZE(PyString_GET_SIZE(arg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000759 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000760#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000761 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000762 uarg = UNICODE_DEFAULT_ENCODING(arg);
763 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000764 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000765 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000766 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000767 STORE_SIZE(PyString_GET_SIZE(uarg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000768 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000769#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000770 else { /* any buffer-like object */
771 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000772 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000773 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000774 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000775 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000776 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000777 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000778 } else {
779 char **p = va_arg(*p_va, char **);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000780
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000781 if (PyString_Check(arg))
782 *p = PyString_AS_STRING(arg);
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);
Marc-André Lemburg6f15e572001-05-02 17:16:16 +0000790 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000791#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000792 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000793 return converterr("string", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000794 if ((int)strlen(*p) != PyString_Size(arg))
795 return converterr("string without null bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000796 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000797 }
798 break;
799 }
800
801 case 'z': {/* string, may be NULL (None) */
802 if (*format == '#') { /* any buffer-like object */
803 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000804 FETCH_SIZE;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000805
806 if (arg == Py_None) {
807 *p = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000808 STORE_SIZE(0);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000809 }
810 else if (PyString_Check(arg)) {
811 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000812 STORE_SIZE(PyString_GET_SIZE(arg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000813 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000814#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000815 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000816 uarg = UNICODE_DEFAULT_ENCODING(arg);
817 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000818 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000819 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000820 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000821 STORE_SIZE(PyString_GET_SIZE(uarg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000822 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000823#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000824 else { /* any buffer-like object */
825 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000826 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000827 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000828 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000829 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000830 }
831 format++;
832 } else {
833 char **p = va_arg(*p_va, char **);
834
835 if (arg == Py_None)
836 *p = 0;
837 else if (PyString_Check(arg))
Jeremy Hyltona4c8cd72001-10-10 02:51:08 +0000838 *p = PyString_AS_STRING(arg);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000839#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000840 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000841 uarg = UNICODE_DEFAULT_ENCODING(arg);
842 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000843 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000844 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000845 *p = PyString_AS_STRING(uarg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000846 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000847#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000848 else
849 return converterr("string or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000850 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000851 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000852 FETCH_SIZE;
Thomas Woutersc3547a32006-03-01 21:31:21 +0000853 assert(0); /* XXX redundant with if-case */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000854 if (arg == Py_None)
855 *q = 0;
856 else
857 *q = PyString_Size(arg);
858 format++;
859 }
860 else if (*p != NULL &&
861 (int)strlen(*p) != PyString_Size(arg))
862 return converterr(
863 "string without null bytes or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000864 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000865 }
866 break;
867 }
868
869 case 'e': {/* encoded string */
870 char **buffer;
871 const char *encoding;
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000872 PyObject *s;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000873 int size, recode_strings;
874
875 /* Get 'e' parameter: the encoding name */
876 encoding = (const char *)va_arg(*p_va, const char *);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000877#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000878 if (encoding == NULL)
879 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000880#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000881
882 /* Get output buffer parameter:
883 's' (recode all objects via Unicode) or
884 't' (only recode non-string objects)
885 */
886 if (*format == 's')
887 recode_strings = 1;
888 else if (*format == 't')
889 recode_strings = 0;
890 else
891 return converterr(
892 "(unknown parser marker combination)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000893 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000894 buffer = (char **)va_arg(*p_va, char **);
895 format++;
896 if (buffer == NULL)
897 return converterr("(buffer is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000898 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000899
900 /* Encode object */
901 if (!recode_strings && PyString_Check(arg)) {
902 s = arg;
903 Py_INCREF(s);
904 }
905 else {
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000906#ifdef Py_USING_UNICODE
907 PyObject *u;
908
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000909 /* Convert object to Unicode */
910 u = PyUnicode_FromObject(arg);
911 if (u == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000912 return converterr(
913 "string or unicode or text buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000914 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000915
916 /* Encode object; use default error handling */
917 s = PyUnicode_AsEncodedString(u,
918 encoding,
919 NULL);
920 Py_DECREF(u);
921 if (s == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000922 return converterr("(encoding failed)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000923 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000924 if (!PyString_Check(s)) {
925 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000926 return converterr(
927 "(encoder failed to return a string)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000928 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000929 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000930#else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000931 return converterr("string<e>", arg, msgbuf, bufsize);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000932#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000933 }
934 size = PyString_GET_SIZE(s);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000935
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000936 /* Write output; output is guaranteed to be 0-terminated */
937 if (*format == '#') {
938 /* Using buffer length parameter '#':
939
940 - if *buffer is NULL, a new buffer of the
941 needed size is allocated and the data
942 copied into it; *buffer is updated to point
943 to the new buffer; the caller is
944 responsible for PyMem_Free()ing it after
945 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000946
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000947 - if *buffer is not NULL, the data is
948 copied to *buffer; *buffer_len has to be
949 set to the size of the buffer on input;
950 buffer overflow is signalled with an error;
951 buffer has to provide enough room for the
952 encoded string plus the trailing 0-byte
953
954 - in both cases, *buffer_len is updated to
955 the size of the buffer /excluding/ the
956 trailing 0-byte
957
958 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000959 FETCH_SIZE;
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000960
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000961 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000962 if (q == NULL && q2 == NULL) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000963 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000964 return converterr(
965 "(buffer_len is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000966 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000967 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000968 if (*buffer == NULL) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000969 *buffer = PyMem_NEW(char, size + 1);
970 if (*buffer == NULL) {
971 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000972 return converterr(
973 "(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000974 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000975 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000976 if(addcleanup(*buffer, freelist)) {
977 Py_DECREF(s);
978 return converterr(
979 "(cleanup problem)",
980 arg, msgbuf, bufsize);
981 }
Fred Drake25871c02000-05-03 15:17:02 +0000982 } else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000983 if (size + 1 > BUFFER_LEN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000984 Py_DECREF(s);
985 return converterr(
986 "(buffer overflow)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000987 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000988 }
Fred Drake25871c02000-05-03 15:17:02 +0000989 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000990 memcpy(*buffer,
991 PyString_AS_STRING(s),
992 size + 1);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000993 STORE_SIZE(size);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000994 } else {
995 /* Using a 0-terminated buffer:
996
997 - the encoded string has to be 0-terminated
998 for this variant to work; if it is not, an
999 error raised
Fred Drake25871c02000-05-03 15:17:02 +00001000
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001001 - a new buffer of the needed size is
1002 allocated and the data copied into it;
1003 *buffer is updated to point to the new
1004 buffer; the caller is responsible for
1005 PyMem_Free()ing it after usage
1006
1007 */
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001008 if ((int)strlen(PyString_AS_STRING(s)) != size) {
1009 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001010 return converterr(
1011 "(encoded string without NULL bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001012 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001013 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001014 *buffer = PyMem_NEW(char, size + 1);
1015 if (*buffer == NULL) {
1016 Py_DECREF(s);
1017 return converterr("(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001018 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001019 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001020 if(addcleanup(*buffer, freelist)) {
1021 Py_DECREF(s);
1022 return converterr("(cleanup problem)",
1023 arg, msgbuf, bufsize);
1024 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001025 memcpy(*buffer,
1026 PyString_AS_STRING(s),
1027 size + 1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001028 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001029 Py_DECREF(s);
1030 break;
1031 }
1032
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001033#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001034 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1035 if (*format == '#') { /* any buffer-like object */
1036 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001037 FETCH_SIZE;
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001038 if (PyUnicode_Check(arg)) {
1039 *p = PyUnicode_AS_UNICODE(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001040 STORE_SIZE(PyUnicode_GET_SIZE(arg));
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001041 }
1042 else {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001043 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001044 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001045 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001046 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001047 STORE_SIZE(count/(sizeof(Py_UNICODE)));
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001048 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001049 format++;
1050 } else {
1051 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossume826ef02000-03-10 23:02:17 +00001052 if (PyUnicode_Check(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001053 *p = PyUnicode_AS_UNICODE(arg);
1054 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001055 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001056 }
1057 break;
1058 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001059#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001060
1061 case 'S': { /* string object */
1062 PyObject **p = va_arg(*p_va, PyObject **);
1063 if (PyString_Check(arg))
1064 *p = arg;
1065 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001066 return converterr("string", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001067 break;
1068 }
1069
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001070#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001071 case 'U': { /* Unicode object */
1072 PyObject **p = va_arg(*p_va, PyObject **);
1073 if (PyUnicode_Check(arg))
1074 *p = 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 break;
1078 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001079#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001080
1081 case 'O': { /* object */
1082 PyTypeObject *type;
1083 PyObject **p;
1084 if (*format == '!') {
1085 type = va_arg(*p_va, PyTypeObject*);
1086 p = va_arg(*p_va, PyObject **);
1087 format++;
Guido van Rossumcbfc8552001-08-28 16:37:51 +00001088 if (PyType_IsSubtype(arg->ob_type, type))
Guido van Rossume826ef02000-03-10 23:02:17 +00001089 *p = arg;
1090 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001091 return converterr(type->tp_name, arg, msgbuf, bufsize);
Guido van Rossumfccfe891998-05-15 22:04:07 +00001092
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001093 }
1094 else if (*format == '?') {
1095 inquiry pred = va_arg(*p_va, inquiry);
1096 p = va_arg(*p_va, PyObject **);
1097 format++;
1098 if ((*pred)(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001099 *p = arg;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001100 else
1101 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001102 arg, msgbuf, bufsize);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001103
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001104 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001105 else if (*format == '&') {
1106 typedef int (*converter)(PyObject *, void *);
1107 converter convert = va_arg(*p_va, converter);
1108 void *addr = va_arg(*p_va, void *);
1109 format++;
1110 if (! (*convert)(arg, addr))
1111 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001112 arg, msgbuf, bufsize);
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001113 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001114 else {
1115 p = va_arg(*p_va, PyObject **);
1116 *p = arg;
1117 }
1118 break;
1119 }
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001120
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001121
1122 case 'w': { /* memory buffer, read-write access */
1123 void **p = va_arg(*p_va, void **);
1124 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1125 int count;
1126
1127 if (pb == NULL ||
1128 pb->bf_getwritebuffer == NULL ||
1129 pb->bf_getsegcount == NULL)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001130 return converterr("read-write buffer", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001131 if ((*pb->bf_getsegcount)(arg, NULL) != 1)
1132 return converterr("single-segment read-write buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001133 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001134 if ((count = pb->bf_getwritebuffer(arg, 0, p)) < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001135 return converterr("(unspecified)", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001136 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001137 FETCH_SIZE;
1138 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001139 format++;
1140 }
1141 break;
1142 }
1143
1144 case 't': { /* 8-bit character buffer, read-only access */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001145 char **p = va_arg(*p_va, char **);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001146 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001147 int count;
1148
1149 if (*format++ != '#')
1150 return converterr(
1151 "invalid use of 't' format character",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001152 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001153 if (!PyType_HasFeature(arg->ob_type,
Jeremy Hylton4819e972001-10-11 14:40:37 +00001154 Py_TPFLAGS_HAVE_GETCHARBUFFER) ||
1155 pb == NULL || pb->bf_getcharbuffer == NULL ||
1156 pb->bf_getsegcount == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001157 return converterr(
1158 "string or read-only character buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001159 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001160
Jeremy Hylton4819e972001-10-11 14:40:37 +00001161 if (pb->bf_getsegcount(arg, NULL) != 1)
1162 return converterr(
1163 "string or single-segment read-only buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001164 arg, msgbuf, bufsize);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001165
1166 count = pb->bf_getcharbuffer(arg, 0, p);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001167 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001168 return converterr("(unspecified)", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001169 {
1170 FETCH_SIZE;
1171 STORE_SIZE(count);
1172 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001173 break;
1174 }
1175
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001176 default:
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001177 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001178
1179 }
1180
1181 *p_format = format;
1182 return NULL;
1183}
Guido van Rossumaa354651996-08-19 19:32:04 +00001184
Martin v. Löwis18e16552006-02-15 17:27:45 +00001185static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001186convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001187{
1188 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001189 Py_ssize_t count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001190 if (pb == NULL ||
1191 pb->bf_getreadbuffer == NULL ||
1192 pb->bf_getsegcount == NULL) {
1193 *errmsg = "string or read-only buffer";
1194 return -1;
1195 }
1196 if ((*pb->bf_getsegcount)(arg, NULL) != 1) {
1197 *errmsg = "string or single-segment read-only buffer";
1198 return -1;
1199 }
1200 if ((count = (*pb->bf_getreadbuffer)(arg, 0, p)) < 0) {
1201 *errmsg = "(unspecified)";
1202 }
1203 return count;
1204}
Guido van Rossumaa354651996-08-19 19:32:04 +00001205
1206/* Support for keyword arguments donated by
1207 Geoff Philbrick <philbric@delphi.hks.com> */
1208
Tim Petersf8cd3e82001-10-27 04:26:57 +00001209/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001210int
1211PyArg_ParseTupleAndKeywords(PyObject *args,
1212 PyObject *keywords,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001213 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001214 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001215{
1216 int retval;
1217 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001218
1219 if ((args == NULL || !PyTuple_Check(args)) ||
1220 (keywords != NULL && !PyDict_Check(keywords)) ||
1221 format == NULL ||
1222 kwlist == NULL)
1223 {
1224 PyErr_BadInternalCall();
Tim Petersf8cd3e82001-10-27 04:26:57 +00001225 return 0;
Tim Peters45772cd2001-10-27 03:58:40 +00001226 }
1227
Guido van Rossumaa354651996-08-19 19:32:04 +00001228 va_start(va, kwlist);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001229 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1230 va_end(va);
1231 return retval;
1232}
1233
1234int
1235_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1236 PyObject *keywords,
1237 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001238 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001239{
1240 int retval;
1241 va_list va;
1242
1243 if ((args == NULL || !PyTuple_Check(args)) ||
1244 (keywords != NULL && !PyDict_Check(keywords)) ||
1245 format == NULL ||
1246 kwlist == NULL)
1247 {
1248 PyErr_BadInternalCall();
1249 return 0;
1250 }
1251
1252 va_start(va, kwlist);
1253 retval = vgetargskeywords(args, keywords, format,
1254 kwlist, &va, FLAG_SIZE_T);
Guido van Rossumaa354651996-08-19 19:32:04 +00001255 va_end(va);
1256 return retval;
1257}
1258
1259
Brett Cannon711e7d92004-07-10 22:20:32 +00001260int
1261PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001262 PyObject *keywords,
1263 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001264 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001265{
1266 int retval;
1267 va_list lva;
1268
1269 if ((args == NULL || !PyTuple_Check(args)) ||
1270 (keywords != NULL && !PyDict_Check(keywords)) ||
1271 format == NULL ||
1272 kwlist == NULL)
1273 {
1274 PyErr_BadInternalCall();
1275 return 0;
1276 }
1277
1278#ifdef VA_LIST_IS_ARRAY
1279 memcpy(lva, va, sizeof(va_list));
1280#else
1281#ifdef __va_copy
1282 __va_copy(lva, va);
1283#else
1284 lva = va;
1285#endif
1286#endif
1287
Martin v. Löwis18e16552006-02-15 17:27:45 +00001288 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1289 return retval;
1290}
1291
1292int
1293_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1294 PyObject *keywords,
1295 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001296 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001297{
1298 int retval;
1299 va_list lva;
1300
1301 if ((args == NULL || !PyTuple_Check(args)) ||
1302 (keywords != NULL && !PyDict_Check(keywords)) ||
1303 format == NULL ||
1304 kwlist == NULL)
1305 {
1306 PyErr_BadInternalCall();
1307 return 0;
1308 }
1309
1310#ifdef VA_LIST_IS_ARRAY
1311 memcpy(lva, va, sizeof(va_list));
1312#else
1313#ifdef __va_copy
1314 __va_copy(lva, va);
1315#else
1316 lva = va;
1317#endif
1318#endif
1319
1320 retval = vgetargskeywords(args, keywords, format,
1321 kwlist, &lva, FLAG_SIZE_T);
Brett Cannon711e7d92004-07-10 22:20:32 +00001322 return retval;
1323}
1324
1325
Guido van Rossumaa354651996-08-19 19:32:04 +00001326static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001327vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001328 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001329{
Tim Petersdc5eff92001-10-27 06:53:00 +00001330 char msgbuf[512];
Guido van Rossumaa354651996-08-19 19:32:04 +00001331 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001332 const char *fname, *message;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001333 int min, max;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001334 const char *formatsave;
Tim Petersb639d492001-10-27 07:00:56 +00001335 int i, len, nargs, nkeywords;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001336 const char *msg;
1337 char **p;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001338 PyObject *freelist = NULL;
Tim Petersf4331c12001-10-27 00:17:34 +00001339
Tim Peters45772cd2001-10-27 03:58:40 +00001340 assert(args != NULL && PyTuple_Check(args));
1341 assert(keywords == NULL || PyDict_Check(keywords));
1342 assert(format != NULL);
1343 assert(kwlist != NULL);
1344 assert(p_va != NULL);
1345
Tim Petersf8cd3e82001-10-27 04:26:57 +00001346 /* Search the format:
1347 message <- error msg, if any (else NULL).
Tim Peterscffed4b2001-11-29 03:26:37 +00001348 fname <- routine name, if any (else NULL).
Tim Petersf8cd3e82001-10-27 04:26:57 +00001349 min <- # of required arguments, or -1 if all are required.
1350 max <- most arguments (required + optional).
Tim Peters62d48e12001-10-27 06:42:16 +00001351 Check that kwlist has a non-NULL entry for each arg.
Tim Petersf8cd3e82001-10-27 04:26:57 +00001352 Raise error if a tuple arg spec is found.
1353 */
1354 fname = message = NULL;
Tim Peters6fb26352001-10-27 04:38:11 +00001355 formatsave = format;
Tim Peters62d48e12001-10-27 06:42:16 +00001356 p = kwlist;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001357 min = -1;
1358 max = 0;
1359 while ((i = *format++) != '\0') {
Neal Norwitz30b5c5d2005-12-19 06:05:18 +00001360 if (isalpha(Py_CHARMASK(i)) && i != 'e') {
Tim Petersf8cd3e82001-10-27 04:26:57 +00001361 max++;
Tim Peters62d48e12001-10-27 06:42:16 +00001362 if (*p == NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001363 PyErr_SetString(PyExc_RuntimeError,
1364 "more argument specifiers than "
1365 "keyword list entries");
Tim Peters62d48e12001-10-27 06:42:16 +00001366 return 0;
1367 }
1368 p++;
1369 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001370 else if (i == '|')
1371 min = max;
1372 else if (i == ':') {
1373 fname = format;
1374 break;
1375 }
1376 else if (i == ';') {
1377 message = format;
1378 break;
1379 }
1380 else if (i == '(') {
Tim Peterscffed4b2001-11-29 03:26:37 +00001381 PyErr_SetString(PyExc_RuntimeError,
1382 "tuple found in format when using keyword "
1383 "arguments");
Guido van Rossumaa354651996-08-19 19:32:04 +00001384 return 0;
1385 }
Tim Peters62d48e12001-10-27 06:42:16 +00001386 }
1387 format = formatsave;
1388 if (*p != NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001389 PyErr_SetString(PyExc_RuntimeError,
1390 "more keyword list entries than "
1391 "argument specifiers");
Tim Peters62d48e12001-10-27 06:42:16 +00001392 return 0;
1393 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001394 if (min < 0) {
1395 /* All arguments are required. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001396 min = max;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001397 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001398
Tim Peters6fb26352001-10-27 04:38:11 +00001399 nargs = PyTuple_GET_SIZE(args);
Tim Petersb0872fc2001-10-27 04:45:34 +00001400 nkeywords = keywords == NULL ? 0 : PyDict_Size(keywords);
Tim Petersf8cd3e82001-10-27 04:26:57 +00001401
Guido van Rossumaa354651996-08-19 19:32:04 +00001402 /* make sure there are no duplicate values for an argument;
1403 its not clear when to use the term "keyword argument vs.
1404 keyword parameter in messages */
Tim Petersb054be42001-10-27 05:07:41 +00001405 if (nkeywords > 0) {
Tim Peters6fb26352001-10-27 04:38:11 +00001406 for (i = 0; i < nargs; i++) {
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001407 const char *thiskw = kwlist[i];
Tim Petersa9f47392001-10-27 00:46:09 +00001408 if (thiskw == NULL)
1409 break;
Tim Peters077f5742001-10-27 05:50:39 +00001410 if (PyDict_GetItemString(keywords, thiskw)) {
Tim Petersb054be42001-10-27 05:07:41 +00001411 PyErr_Format(PyExc_TypeError,
1412 "keyword parameter '%s' was given "
1413 "by position and by name",
Tim Petersa9f47392001-10-27 00:46:09 +00001414 thiskw);
Guido van Rossumaa354651996-08-19 19:32:04 +00001415 return 0;
1416 }
Tim Peters0af49162001-10-27 06:14:32 +00001417 else if (PyErr_Occurred())
1418 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001419 }
1420 }
Tim Peters61dde632001-10-27 05:30:17 +00001421
Guido van Rossumaa354651996-08-19 19:32:04 +00001422 /* required arguments missing from args can be supplied by keyword
Georg Brandld7048172006-01-20 17:53:27 +00001423 arguments; set len to the number of positional arguments, and,
Tim Peters62d48e12001-10-27 06:42:16 +00001424 if that's less than the minimum required, add in the number of
1425 required arguments that are supplied by keywords */
Tim Peters6fb26352001-10-27 04:38:11 +00001426 len = nargs;
Tim Peters62d48e12001-10-27 06:42:16 +00001427 if (nkeywords > 0 && nargs < min) {
Tim Peters6fb26352001-10-27 04:38:11 +00001428 for (i = nargs; i < min; i++) {
Tim Peters077f5742001-10-27 05:50:39 +00001429 if (PyDict_GetItemString(keywords, kwlist[i]))
Guido van Rossumaa354651996-08-19 19:32:04 +00001430 len++;
Tim Peters0af49162001-10-27 06:14:32 +00001431 else if (PyErr_Occurred())
1432 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001433 }
1434 }
Tim Peters0af49162001-10-27 06:14:32 +00001435
Guido van Rossumaa354651996-08-19 19:32:04 +00001436 /* make sure we got an acceptable number of arguments; the message
1437 is a little confusing with keywords since keyword arguments
1438 which are supplied, but don't match the required arguments
Michael W. Hudson5253c302005-03-30 16:41:55 +00001439 are not included in the "%d given" part of the message
1440 XXX and this isn't a bug!? */
Guido van Rossumaa354651996-08-19 19:32:04 +00001441 if (len < min || max < len) {
1442 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +00001443 PyOS_snprintf(msgbuf, sizeof(msgbuf),
1444 "%.200s%s takes %s %d argument%s "
1445 "(%d given)",
1446 fname==NULL ? "function" : fname,
1447 fname==NULL ? "" : "()",
1448 min==max ? "exactly"
1449 : len < min ? "at least" : "at most",
1450 len < min ? min : max,
1451 (len < min ? min : max) == 1 ? "" : "s",
1452 len);
Guido van Rossumaa354651996-08-19 19:32:04 +00001453 message = msgbuf;
1454 }
1455 PyErr_SetString(PyExc_TypeError, message);
1456 return 0;
1457 }
Tim Petersc2f01122001-10-27 07:25:06 +00001458
1459 /* convert the positional arguments */
Tim Peters6fb26352001-10-27 04:38:11 +00001460 for (i = 0; i < nargs; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001461 if (*format == '|')
1462 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +00001463 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001464 flags, levels, msgbuf, sizeof(msgbuf),
1465 &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001466 if (msg) {
1467 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001468 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001469 }
1470 }
1471
Tim Petersc2f01122001-10-27 07:25:06 +00001472 /* handle no keyword parameters in call */
Tim Petersb054be42001-10-27 05:07:41 +00001473 if (nkeywords == 0)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001474 return cleanreturn(1, freelist);
Tim Petersb054be42001-10-27 05:07:41 +00001475
Guido van Rossumaa354651996-08-19 19:32:04 +00001476 /* convert the keyword arguments; this uses the format
1477 string where it was left after processing args */
Tim Petersb639d492001-10-27 07:00:56 +00001478 for (i = nargs; i < max; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001479 PyObject *item;
Guido van Rossumaa354651996-08-19 19:32:04 +00001480 if (*format == '|')
1481 format++;
Tim Peters077f5742001-10-27 05:50:39 +00001482 item = PyDict_GetItemString(keywords, kwlist[i]);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001483 if (item != NULL) {
Tim Peters077f5742001-10-27 05:50:39 +00001484 Py_INCREF(item);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001485 msg = convertitem(item, &format, p_va, flags, levels,
1486 msgbuf, sizeof(msgbuf), &freelist);
Tim Peters077f5742001-10-27 05:50:39 +00001487 Py_DECREF(item);
Guido van Rossumaa354651996-08-19 19:32:04 +00001488 if (msg) {
1489 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001490 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001491 }
Tim Petersc2f01122001-10-27 07:25:06 +00001492 --nkeywords;
1493 if (nkeywords == 0)
1494 break;
Guido van Rossumaa354651996-08-19 19:32:04 +00001495 }
Tim Peters0af49162001-10-27 06:14:32 +00001496 else if (PyErr_Occurred())
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001497 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001498 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001499 msg = skipitem(&format, p_va, flags);
Guido van Rossumaa354651996-08-19 19:32:04 +00001500 if (msg) {
1501 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;
1514 if (!PyString_Check(key)) {
1515 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 */
1594#ifdef Py_USING_UNICODE
1595 case 'u': /* unicode string */
1596#endif
1597 case 't': /* buffer, read-only */
1598 case 'w': /* buffer, read-write */
Guido van Rossumaa354651996-08-19 19:32:04 +00001599 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001600 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001601 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001602 if (flags & FLAG_SIZE_T)
1603 (void) va_arg(*p_va, Py_ssize_t *);
1604 else
1605 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001606 format++;
1607 }
1608 break;
1609 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001610
1611 /* object codes */
1612
Guido van Rossumaa354651996-08-19 19:32:04 +00001613 case 'S': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001614#ifdef Py_USING_UNICODE
1615 case 'U': /* unicode string object */
1616#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001617 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001618 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001619 break;
1620 }
1621
1622 case 'O': /* object */
1623 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001624 if (*format == '!') {
1625 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001626 (void) va_arg(*p_va, PyTypeObject*);
1627 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001628 }
1629#if 0
1630/* I don't know what this is for */
1631 else if (*format == '?') {
1632 inquiry pred = va_arg(*p_va, inquiry);
1633 format++;
1634 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001635 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001636 }
1637 }
1638#endif
1639 else if (*format == '&') {
Tim Petersdbd9ba62000-07-09 03:09:57 +00001640 typedef int (*converter)(PyObject *, void *);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001641 (void) va_arg(*p_va, converter);
1642 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001643 format++;
1644 }
1645 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001646 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001647 }
1648 break;
1649 }
1650
1651 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001652err:
Guido van Rossumaa354651996-08-19 19:32:04 +00001653 return "impossible<bad format char>";
1654
1655 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001656
1657 /* The "(...)" format code for tuples is not handled here because
1658 * it is not allowed with keyword args. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001659
1660 *p_format = format;
1661 return NULL;
1662}
Fred Drakee4616e62001-10-23 21:09:29 +00001663
1664
1665int
Martin v. Löwis76246742006-03-01 04:06:10 +00001666PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001667{
Martin v. Löwis76246742006-03-01 04:06:10 +00001668 Py_ssize_t i, l;
Fred Drakee4616e62001-10-23 21:09:29 +00001669 PyObject **o;
1670 va_list vargs;
1671
1672#ifdef HAVE_STDARG_PROTOTYPES
1673 va_start(vargs, max);
1674#else
1675 va_start(vargs);
1676#endif
1677
1678 assert(min >= 0);
1679 assert(min <= max);
1680 if (!PyTuple_Check(args)) {
1681 PyErr_SetString(PyExc_SystemError,
1682 "PyArg_UnpackTuple() argument list is not a tuple");
1683 return 0;
1684 }
1685 l = PyTuple_GET_SIZE(args);
1686 if (l < min) {
1687 if (name != NULL)
1688 PyErr_Format(
1689 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001690 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001691 name, (min == max ? "" : "at least "), min, l);
1692 else
1693 PyErr_Format(
1694 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001695 "unpacked tuple should have %s%zd elements,"
1696 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001697 (min == max ? "" : "at least "), min, l);
1698 va_end(vargs);
1699 return 0;
1700 }
1701 if (l > max) {
1702 if (name != NULL)
1703 PyErr_Format(
1704 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001705 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001706 name, (min == max ? "" : "at most "), max, l);
1707 else
1708 PyErr_Format(
1709 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001710 "unpacked tuple should have %s%zd elements,"
1711 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001712 (min == max ? "" : "at most "), max, l);
1713 va_end(vargs);
1714 return 0;
1715 }
1716 for (i = 0; i < l; i++) {
1717 o = va_arg(vargs, PyObject **);
1718 *o = PyTuple_GET_ITEM(args, i);
1719 }
1720 va_end(vargs);
1721 return 1;
1722}
Georg Brandl02c42872005-08-26 06:42:30 +00001723
1724
1725/* For type constructors that don't take keyword args
1726 *
1727 * Sets a TypeError and returns 0 if the kwds dict is
1728 * not emtpy, returns 1 otherwise
1729 */
1730int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001731_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001732{
1733 if (kw == NULL)
1734 return 1;
1735 if (!PyDict_CheckExact(kw)) {
1736 PyErr_BadInternalCall();
1737 return 0;
1738 }
1739 if (PyDict_Size(kw) == 0)
1740 return 1;
1741
1742 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1743 funcname);
1744 return 0;
1745}