blob: 508055e6905bccce832f01d5e5b6664b5c939ed0 [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
Anthony Baxter97300382006-04-12 04:38:54 +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
Martin v. Löwis5cb69362006-04-14 09:08:42 +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++;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000209 break;
210 case ')':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000211 if (level == 0)
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000212 Py_FatalError("excess ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000213 else
214 level--;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000215 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000216 case '\0':
217 endfmt = 1;
218 break;
219 case ':':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000220 fname = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000221 endfmt = 1;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000222 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000223 case ';':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000224 message = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000225 endfmt = 1;
226 break;
227 default:
228 if (level == 0) {
229 if (c == 'O')
230 max++;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000231 else if (isalpha(Py_CHARMASK(c))) {
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000232 if (c != 'e') /* skip encoded */
233 max++;
234 } else if (c == '|')
235 min = max;
236 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000237 break;
238 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000239 }
240
241 if (level != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000242 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000243
244 if (min < 0)
245 min = max;
246
247 format = formatsave;
248
249 if (compat) {
250 if (max == 0) {
251 if (args == NULL)
252 return 1;
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000253 PyOS_snprintf(msgbuf, sizeof(msgbuf),
254 "%.200s%s takes no arguments",
255 fname==NULL ? "function" : fname,
256 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000257 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000258 return 0;
259 }
260 else if (min == 1 && max == 1) {
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000261 if (args == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000262 PyOS_snprintf(msgbuf, sizeof(msgbuf),
263 "%.200s%s takes at least one argument",
264 fname==NULL ? "function" : fname,
265 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000266 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000267 return 0;
268 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000269 msg = convertitem(args, &format, p_va, flags, levels,
270 msgbuf, sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000271 if (msg == NULL)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000272 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000273 seterror(levels[0], msg, levels+1, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000274 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000275 }
276 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000277 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000278 "old style getargs format uses new features");
279 return 0;
280 }
281 }
282
Guido van Rossum79f25d91997-04-29 20:08:16 +0000283 if (!PyTuple_Check(args)) {
284 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000285 "new style getargs format but argument is not a tuple");
286 return 0;
287 }
288
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000289 len = PyTuple_GET_SIZE(args);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000290
291 if (len < min || max < len) {
292 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000293 PyOS_snprintf(msgbuf, sizeof(msgbuf),
294 "%.150s%s takes %s %d argument%s "
Neal Norwitz20dd93f2006-02-19 19:34:15 +0000295 "(%ld given)",
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000296 fname==NULL ? "function" : fname,
297 fname==NULL ? "" : "()",
298 min==max ? "exactly"
299 : len < min ? "at least" : "at most",
300 len < min ? min : max,
301 (len < min ? min : max) == 1 ? "" : "s",
Neal Norwitz9a276172006-02-20 18:57:39 +0000302 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000303 message = msgbuf;
304 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000305 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000306 return 0;
307 }
308
309 for (i = 0; i < len; i++) {
310 if (*format == '|')
311 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000312 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000313 flags, levels, msgbuf,
314 sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000315 if (msg) {
316 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000317 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000318 }
319 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000320
Neal Norwitz4ac13df2005-12-19 06:10:07 +0000321 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
Guido van Rossum7d4f68c1997-12-19 04:25:23 +0000322 *format != '(' &&
Guido van Rossum231a41e1997-12-09 20:36:39 +0000323 *format != '|' && *format != ':' && *format != ';') {
324 PyErr_Format(PyExc_SystemError,
Guido van Rossum0d6b49e1998-01-19 22:22:44 +0000325 "bad format string: %.200s", formatsave);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000326 return cleanreturn(0, freelist);
Guido van Rossum231a41e1997-12-09 20:36:39 +0000327 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000328
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000329 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000330}
331
332
333
334static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000335seterror(int iarg, const char *msg, int *levels, const char *fname,
336 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000337{
Marc-André Lemburgd4c0a9c2001-11-28 11:47:00 +0000338 char buf[512];
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000339 int i;
340 char *p = buf;
341
Guido van Rossum79f25d91997-04-29 20:08:16 +0000342 if (PyErr_Occurred())
Guido van Rossum64fc6491995-01-21 14:09:37 +0000343 return;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000344 else if (message == NULL) {
345 if (fname != NULL) {
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000346 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000347 p += strlen(p);
348 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000349 if (iarg != 0) {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000350 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000351 "argument %d", iarg);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000352 i = 0;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000353 p += strlen(p);
Georg Brandl5f135782006-07-26 08:03:10 +0000354 while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
355 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000356 ", item %d", levels[i]-1);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000357 p += strlen(p);
358 i++;
359 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000360 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000361 else {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000362 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
Ka-Ping Yee20579702001-01-15 22:14:16 +0000363 p += strlen(p);
364 }
Tim Petersfaad5ad2001-12-03 00:43:33 +0000365 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000366 message = buf;
367 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000368 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000369}
370
371
372/* Convert a tuple argument.
373 On entry, *p_format points to the character _after_ the opening '('.
374 On successful exit, *p_format points to the closing ')'.
375 If successful:
376 *p_format and *p_va are updated,
377 *levels and *msgbuf are untouched,
378 and NULL is returned.
379 If the argument is invalid:
380 *p_format is unchanged,
381 *p_va is undefined,
382 *levels is a 0-terminated list of item numbers,
383 *msgbuf contains an error message, whose format is:
Ka-Ping Yee20579702001-01-15 22:14:16 +0000384 "must be <typename1>, not <typename2>", where:
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000385 <typename1> is the name of the expected type, and
386 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000387 and msgbuf is returned.
388*/
389
390static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000391converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
392 int *levels, char *msgbuf, size_t bufsize, int toplevel,
393 PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000394{
395 int level = 0;
396 int n = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000397 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000398 int i;
399
400 for (;;) {
401 int c = *format++;
402 if (c == '(') {
403 if (level == 0)
404 n++;
405 level++;
406 }
407 else if (c == ')') {
408 if (level == 0)
409 break;
410 level--;
411 }
412 else if (c == ':' || c == ';' || c == '\0')
413 break;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000414 else if (level == 0 && isalpha(Py_CHARMASK(c)))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000415 n++;
416 }
417
Ka-Ping Yee20579702001-01-15 22:14:16 +0000418 if (!PySequence_Check(arg) || PyString_Check(arg)) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000419 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000420 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000421 toplevel ? "expected %d arguments, not %.50s" :
422 "must be %d-item sequence, not %.50s",
423 n,
424 arg == Py_None ? "None" : arg->ob_type->tp_name);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000425 return msgbuf;
426 }
427
Jeremy Hylton03657cf2000-07-12 13:05:33 +0000428 if ((i = PySequence_Size(arg)) != n) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000429 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000430 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000431 toplevel ? "expected %d arguments, not %d" :
432 "must be sequence of length %d, not %d",
433 n, i);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000434 return msgbuf;
435 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000436
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000437 format = *p_format;
438 for (i = 0; i < n; i++) {
439 char *msg;
Guido van Rossum66368cc1999-02-17 23:16:43 +0000440 PyObject *item;
441 item = PySequence_GetItem(arg, i);
Georg Brandl5f135782006-07-26 08:03:10 +0000442 if (item == NULL) {
443 PyErr_Clear();
444 levels[0] = i+1;
445 levels[1] = 0;
446 strncpy(msgbuf, "is not retrievable", bufsize);
447 return msgbuf;
448 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000449 msg = convertitem(item, &format, p_va, flags, levels+1,
450 msgbuf, bufsize, freelist);
Guido van Rossum66368cc1999-02-17 23:16:43 +0000451 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
452 Py_XDECREF(item);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000453 if (msg != NULL) {
454 levels[0] = i+1;
455 return msg;
456 }
457 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000458
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000459 *p_format = format;
460 return NULL;
461}
462
463
464/* Convert a single item. */
465
466static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000467convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
468 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000469{
470 char *msg;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000471 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000472
473 if (*format == '(' /* ')' */) {
474 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000475 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000476 bufsize, 0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000477 if (msg == NULL)
478 format++;
479 }
480 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000481 msg = convertsimple(arg, &format, p_va, flags,
482 msgbuf, bufsize, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000483 if (msg != NULL)
484 levels[0] = 0;
485 }
486 if (msg == NULL)
487 *p_format = format;
488 return msg;
489}
490
491
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000492
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000493#define UNICODE_DEFAULT_ENCODING(arg) \
494 _PyUnicode_AsDefaultEncodedString(arg, NULL)
495
496/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000497
498static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000499converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000500{
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000501 assert(expected != NULL);
502 assert(arg != NULL);
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000503 PyOS_snprintf(msgbuf, bufsize,
504 "must be %.50s, not %.50s", expected,
505 arg == Py_None ? "None" : arg->ob_type->tp_name);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000506 return msgbuf;
507}
508
509#define CONV_UNICODE "(unicode conversion error)"
510
Neil Schemenauer5042da62003-02-04 20:59:40 +0000511/* explicitly check for float arguments when integers are expected. For now
512 * signal a warning. Returns true if an exception was raised. */
513static int
514float_argument_error(PyObject *arg)
515{
516 if (PyFloat_Check(arg) &&
517 PyErr_Warn(PyExc_DeprecationWarning,
518 "integer argument expected, got float" ))
519 return 1;
520 else
521 return 0;
522}
523
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000524/* Convert a non-tuple argument. Return NULL if conversion went OK,
525 or a string with a message describing the failure. The message is
526 formatted as "must be <desired type>, not <actual type>".
527 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000528 Don't call if a tuple is expected.
529
530 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000531*/
532
533static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000534convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000535 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000536{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000537 /* For # codes */
538#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
539 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
540 else q=va_arg(*p_va, int*);
541#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
542#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
543
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000544 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000545 char c = *format++;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000546#ifdef Py_USING_UNICODE
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000547 PyObject *uarg;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000548#endif
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000549
550 switch (c) {
551
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000552 case 'b': { /* unsigned byte -- very short int */
553 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000554 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000555 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000556 return converterr("integer<b>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000557 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000558 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000559 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000560 else if (ival < 0) {
561 PyErr_SetString(PyExc_OverflowError,
562 "unsigned byte integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000563 return converterr("integer<b>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000564 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000565 else if (ival > UCHAR_MAX) {
566 PyErr_SetString(PyExc_OverflowError,
567 "unsigned byte integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000568 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000569 }
570 else
571 *p = (unsigned char) ival;
572 break;
573 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000574
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000575 case 'B': {/* byte sized bitfield - both signed and unsigned
576 values allowed */
577 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000578 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000579 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000580 return converterr("integer<B>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000581 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000582 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000583 return converterr("integer<B>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000584 else
585 *p = (unsigned char) ival;
586 break;
587 }
Jack Jansencc22fbe2000-08-05 21:29:58 +0000588
Guido van Rossumfce26e72003-04-18 00:12:30 +0000589 case 'h': {/* signed short int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000590 short *p = va_arg(*p_va, short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000591 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000592 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000593 return converterr("integer<h>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000594 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000595 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000596 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfce26e72003-04-18 00:12:30 +0000597 else if (ival < SHRT_MIN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000598 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000599 "signed short integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000600 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000601 }
Guido van Rossumfce26e72003-04-18 00:12:30 +0000602 else if (ival > SHRT_MAX) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000603 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000604 "signed short integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000605 return converterr("integer<h>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000606 }
607 else
608 *p = (short) ival;
609 break;
610 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000611
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000612 case 'H': { /* short int sized bitfield, both signed and
613 unsigned allowed */
614 unsigned short *p = va_arg(*p_va, unsigned short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000615 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000616 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000617 return converterr("integer<H>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000618 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000619 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000620 return converterr("integer<H>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000621 else
622 *p = (unsigned short) ival;
623 break;
624 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000625
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000626 case 'i': {/* signed int */
627 int *p = va_arg(*p_va, int *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000628 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000629 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000630 return converterr("integer<i>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000631 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000632 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000633 return converterr("integer<i>", arg, msgbuf, bufsize);
Georg Brandl98251f82006-06-08 13:31:07 +0000634 else if (ival > INT_MAX) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000635 PyErr_SetString(PyExc_OverflowError,
636 "signed integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000637 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000638 }
Georg Brandl98251f82006-06-08 13:31:07 +0000639 else if (ival < INT_MIN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000640 PyErr_SetString(PyExc_OverflowError,
641 "signed integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000642 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000643 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000644 else
645 *p = ival;
646 break;
647 }
648
Thomas Hellera4ea6032003-04-17 18:55:45 +0000649 case 'I': { /* int sized bitfield, both signed and
650 unsigned allowed */
651 unsigned int *p = va_arg(*p_va, unsigned int *);
652 unsigned int ival;
653 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000654 return converterr("integer<I>", arg, msgbuf, bufsize);
Skip Montanarob5079722006-04-18 00:57:15 +0000655 ival = (unsigned int)PyInt_AsUnsignedLongMask(arg);
656 if (ival == (unsigned int)-1 && PyErr_Occurred())
Thomas Hellera4ea6032003-04-17 18:55:45 +0000657 return converterr("integer<I>", arg, msgbuf, bufsize);
658 else
659 *p = ival;
660 break;
661 }
662
Martin v. Löwis18e16552006-02-15 17:27:45 +0000663 case 'n': /* Py_ssize_t */
664#if SIZEOF_SIZE_T != SIZEOF_LONG
665 {
666 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
667 Py_ssize_t ival;
668 if (float_argument_error(arg))
Georg Brandl7f573f72006-04-13 07:59:30 +0000669 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000670 ival = PyInt_AsSsize_t(arg);
671 if (ival == -1 && PyErr_Occurred())
Georg Brandl7f573f72006-04-13 07:59:30 +0000672 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000673 *p = ival;
674 break;
675 }
676#endif
677 /* Fall through from 'n' to 'l' if Py_ssize_t is int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000678 case 'l': {/* long int */
679 long *p = va_arg(*p_va, long *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000680 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000681 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000682 return converterr("integer<l>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000683 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000684 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000685 return converterr("integer<l>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000686 else
687 *p = ival;
688 break;
689 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000690
691 case 'k': { /* long sized bitfield */
692 unsigned long *p = va_arg(*p_va, unsigned long *);
693 unsigned long ival;
694 if (PyInt_Check(arg))
695 ival = PyInt_AsUnsignedLongMask(arg);
696 else if (PyLong_Check(arg))
697 ival = PyLong_AsUnsignedLongMask(arg);
698 else
699 return converterr("integer<k>", arg, msgbuf, bufsize);
700 *p = ival;
701 break;
702 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000703
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000704#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000705 case 'L': {/* PY_LONG_LONG */
706 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
707 PY_LONG_LONG ival = PyLong_AsLongLong( arg );
708 if( ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000709 return converterr("long<L>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000710 } else {
711 *p = ival;
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000712 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000713 break;
714 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000715
716 case 'K': { /* long long sized bitfield */
717 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
718 unsigned PY_LONG_LONG ival;
Thomas Hellera4ea6032003-04-17 18:55:45 +0000719 if (PyInt_Check(arg))
720 ival = PyInt_AsUnsignedLongMask(arg);
721 else if (PyLong_Check(arg))
722 ival = PyLong_AsUnsignedLongLongMask(arg);
723 else
724 return converterr("integer<K>", arg, msgbuf, bufsize);
725 *p = ival;
726 break;
727 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000728#endif
729
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000730 case 'f': {/* float */
731 float *p = va_arg(*p_va, float *);
732 double dval = PyFloat_AsDouble(arg);
733 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000734 return converterr("float<f>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000735 else
736 *p = (float) dval;
737 break;
738 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000739
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000740 case 'd': {/* double */
741 double *p = va_arg(*p_va, double *);
742 double dval = PyFloat_AsDouble(arg);
743 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000744 return converterr("float<d>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000745 else
746 *p = dval;
747 break;
748 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000749
Guido van Rossum530956d1996-07-21 02:27:43 +0000750#ifndef WITHOUT_COMPLEX
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000751 case 'D': {/* complex double */
752 Py_complex *p = va_arg(*p_va, Py_complex *);
753 Py_complex cval;
754 cval = PyComplex_AsCComplex(arg);
755 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000756 return converterr("complex<D>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000757 else
758 *p = cval;
759 break;
760 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000761#endif /* WITHOUT_COMPLEX */
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000762
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000763 case 'c': {/* char */
764 char *p = va_arg(*p_va, char *);
765 if (PyString_Check(arg) && PyString_Size(arg) == 1)
Jeremy Hylton0407aea2001-10-10 02:51:57 +0000766 *p = PyString_AS_STRING(arg)[0];
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000767 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000768 return converterr("char", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000769 break;
770 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000771
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000772 case 's': {/* string */
773 if (*format == '#') {
774 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000775 FETCH_SIZE;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000776
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000777 if (PyString_Check(arg)) {
778 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000779 STORE_SIZE(PyString_GET_SIZE(arg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000780 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000781#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000782 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000783 uarg = UNICODE_DEFAULT_ENCODING(arg);
784 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000785 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000786 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000787 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000788 STORE_SIZE(PyString_GET_SIZE(uarg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000789 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000790#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000791 else { /* any buffer-like object */
792 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000793 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000794 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000795 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000796 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000797 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000798 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000799 } else {
800 char **p = va_arg(*p_va, char **);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000801
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000802 if (PyString_Check(arg))
803 *p = PyString_AS_STRING(arg);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000804#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000805 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000806 uarg = UNICODE_DEFAULT_ENCODING(arg);
807 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000808 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000809 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000810 *p = PyString_AS_STRING(uarg);
Marc-André Lemburg6f15e572001-05-02 17:16:16 +0000811 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000812#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000813 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000814 return converterr("string", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000815 if ((int)strlen(*p) != PyString_Size(arg))
816 return converterr("string without null bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000817 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000818 }
819 break;
820 }
821
822 case 'z': {/* string, may be NULL (None) */
823 if (*format == '#') { /* any buffer-like object */
824 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000825 FETCH_SIZE;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000826
827 if (arg == Py_None) {
828 *p = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000829 STORE_SIZE(0);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000830 }
831 else if (PyString_Check(arg)) {
832 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000833 STORE_SIZE(PyString_GET_SIZE(arg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000834 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000835#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000836 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000837 uarg = UNICODE_DEFAULT_ENCODING(arg);
838 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000839 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000840 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000841 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000842 STORE_SIZE(PyString_GET_SIZE(uarg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000843 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000844#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000845 else { /* any buffer-like object */
846 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000847 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000848 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000849 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000850 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000851 }
852 format++;
853 } else {
854 char **p = va_arg(*p_va, char **);
855
856 if (arg == Py_None)
857 *p = 0;
858 else if (PyString_Check(arg))
Jeremy Hyltona4c8cd72001-10-10 02:51:08 +0000859 *p = PyString_AS_STRING(arg);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000860#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000861 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000862 uarg = UNICODE_DEFAULT_ENCODING(arg);
863 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000864 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000865 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000866 *p = PyString_AS_STRING(uarg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000867 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000868#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000869 else
870 return converterr("string or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000871 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000872 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000873 FETCH_SIZE;
Thomas Woutersc3547a32006-03-01 21:31:21 +0000874 assert(0); /* XXX redundant with if-case */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000875 if (arg == Py_None)
876 *q = 0;
877 else
878 *q = PyString_Size(arg);
879 format++;
880 }
881 else if (*p != NULL &&
882 (int)strlen(*p) != PyString_Size(arg))
883 return converterr(
884 "string without null bytes or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000885 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000886 }
887 break;
888 }
889
890 case 'e': {/* encoded string */
891 char **buffer;
892 const char *encoding;
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000893 PyObject *s;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000894 int size, recode_strings;
895
896 /* Get 'e' parameter: the encoding name */
897 encoding = (const char *)va_arg(*p_va, const char *);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000898#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000899 if (encoding == NULL)
900 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000901#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000902
903 /* Get output buffer parameter:
904 's' (recode all objects via Unicode) or
905 't' (only recode non-string objects)
906 */
907 if (*format == 's')
908 recode_strings = 1;
909 else if (*format == 't')
910 recode_strings = 0;
911 else
912 return converterr(
913 "(unknown parser marker combination)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000914 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000915 buffer = (char **)va_arg(*p_va, char **);
916 format++;
917 if (buffer == NULL)
918 return converterr("(buffer is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000919 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000920
921 /* Encode object */
922 if (!recode_strings && PyString_Check(arg)) {
923 s = arg;
924 Py_INCREF(s);
925 }
926 else {
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000927#ifdef Py_USING_UNICODE
928 PyObject *u;
929
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000930 /* Convert object to Unicode */
931 u = PyUnicode_FromObject(arg);
932 if (u == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000933 return converterr(
934 "string or unicode or text buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000935 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000936
937 /* Encode object; use default error handling */
938 s = PyUnicode_AsEncodedString(u,
939 encoding,
940 NULL);
941 Py_DECREF(u);
942 if (s == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000943 return converterr("(encoding failed)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000944 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000945 if (!PyString_Check(s)) {
946 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000947 return converterr(
948 "(encoder failed to return a string)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000949 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000950 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000951#else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000952 return converterr("string<e>", arg, msgbuf, bufsize);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000953#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000954 }
955 size = PyString_GET_SIZE(s);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000956
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000957 /* Write output; output is guaranteed to be 0-terminated */
958 if (*format == '#') {
959 /* Using buffer length parameter '#':
960
961 - if *buffer is NULL, a new buffer of the
962 needed size is allocated and the data
963 copied into it; *buffer is updated to point
964 to the new buffer; the caller is
965 responsible for PyMem_Free()ing it after
966 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000967
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000968 - if *buffer is not NULL, the data is
969 copied to *buffer; *buffer_len has to be
970 set to the size of the buffer on input;
971 buffer overflow is signalled with an error;
972 buffer has to provide enough room for the
973 encoded string plus the trailing 0-byte
974
975 - in both cases, *buffer_len is updated to
976 the size of the buffer /excluding/ the
977 trailing 0-byte
978
979 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000980 FETCH_SIZE;
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000981
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000982 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000983 if (q == NULL && q2 == NULL) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000984 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000985 return converterr(
986 "(buffer_len is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000987 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000988 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000989 if (*buffer == NULL) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000990 *buffer = PyMem_NEW(char, size + 1);
991 if (*buffer == NULL) {
992 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000993 return converterr(
994 "(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000995 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000996 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000997 if(addcleanup(*buffer, freelist)) {
998 Py_DECREF(s);
999 return converterr(
1000 "(cleanup problem)",
1001 arg, msgbuf, bufsize);
1002 }
Fred Drake25871c02000-05-03 15:17:02 +00001003 } else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001004 if (size + 1 > BUFFER_LEN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001005 Py_DECREF(s);
1006 return converterr(
1007 "(buffer overflow)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001008 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001009 }
Fred Drake25871c02000-05-03 15:17:02 +00001010 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001011 memcpy(*buffer,
1012 PyString_AS_STRING(s),
1013 size + 1);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001014 STORE_SIZE(size);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001015 } else {
1016 /* Using a 0-terminated buffer:
1017
1018 - the encoded string has to be 0-terminated
1019 for this variant to work; if it is not, an
1020 error raised
Fred Drake25871c02000-05-03 15:17:02 +00001021
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001022 - a new buffer of the needed size is
1023 allocated and the data copied into it;
1024 *buffer is updated to point to the new
1025 buffer; the caller is responsible for
1026 PyMem_Free()ing it after usage
1027
1028 */
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001029 if ((int)strlen(PyString_AS_STRING(s)) != size) {
1030 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001031 return converterr(
1032 "(encoded string without NULL bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001033 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001034 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001035 *buffer = PyMem_NEW(char, size + 1);
1036 if (*buffer == NULL) {
1037 Py_DECREF(s);
1038 return converterr("(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001039 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001040 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001041 if(addcleanup(*buffer, freelist)) {
1042 Py_DECREF(s);
1043 return converterr("(cleanup problem)",
1044 arg, msgbuf, bufsize);
1045 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001046 memcpy(*buffer,
1047 PyString_AS_STRING(s),
1048 size + 1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001049 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001050 Py_DECREF(s);
1051 break;
1052 }
1053
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001054#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001055 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1056 if (*format == '#') { /* any buffer-like object */
1057 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001058 FETCH_SIZE;
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001059 if (PyUnicode_Check(arg)) {
1060 *p = PyUnicode_AS_UNICODE(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001061 STORE_SIZE(PyUnicode_GET_SIZE(arg));
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001062 }
1063 else {
Neal Norwitz61546162006-04-14 05:20:28 +00001064 return converterr("cannot convert raw buffers",
1065 arg, msgbuf, bufsize);
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001066 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001067 format++;
1068 } else {
1069 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossume826ef02000-03-10 23:02:17 +00001070 if (PyUnicode_Check(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001071 *p = PyUnicode_AS_UNICODE(arg);
1072 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001073 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001074 }
1075 break;
1076 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001077#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001078
1079 case 'S': { /* string object */
1080 PyObject **p = va_arg(*p_va, PyObject **);
1081 if (PyString_Check(arg))
1082 *p = arg;
1083 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001084 return converterr("string", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001085 break;
1086 }
1087
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001088#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001089 case 'U': { /* Unicode object */
1090 PyObject **p = va_arg(*p_va, PyObject **);
1091 if (PyUnicode_Check(arg))
1092 *p = arg;
1093 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001094 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001095 break;
1096 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001097#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001098
1099 case 'O': { /* object */
1100 PyTypeObject *type;
1101 PyObject **p;
1102 if (*format == '!') {
1103 type = va_arg(*p_va, PyTypeObject*);
1104 p = va_arg(*p_va, PyObject **);
1105 format++;
Guido van Rossumcbfc8552001-08-28 16:37:51 +00001106 if (PyType_IsSubtype(arg->ob_type, type))
Guido van Rossume826ef02000-03-10 23:02:17 +00001107 *p = arg;
1108 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001109 return converterr(type->tp_name, arg, msgbuf, bufsize);
Guido van Rossumfccfe891998-05-15 22:04:07 +00001110
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001111 }
1112 else if (*format == '?') {
1113 inquiry pred = va_arg(*p_va, inquiry);
1114 p = va_arg(*p_va, PyObject **);
1115 format++;
1116 if ((*pred)(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001117 *p = arg;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001118 else
1119 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001120 arg, msgbuf, bufsize);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001121
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001122 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001123 else if (*format == '&') {
1124 typedef int (*converter)(PyObject *, void *);
1125 converter convert = va_arg(*p_va, converter);
1126 void *addr = va_arg(*p_va, void *);
1127 format++;
1128 if (! (*convert)(arg, addr))
1129 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001130 arg, msgbuf, bufsize);
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001131 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001132 else {
1133 p = va_arg(*p_va, PyObject **);
1134 *p = arg;
1135 }
1136 break;
1137 }
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001138
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001139
1140 case 'w': { /* memory buffer, read-write access */
1141 void **p = va_arg(*p_va, void **);
1142 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1143 int count;
1144
1145 if (pb == NULL ||
1146 pb->bf_getwritebuffer == NULL ||
1147 pb->bf_getsegcount == NULL)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001148 return converterr("read-write buffer", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001149 if ((*pb->bf_getsegcount)(arg, NULL) != 1)
1150 return converterr("single-segment read-write buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001151 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001152 if ((count = pb->bf_getwritebuffer(arg, 0, p)) < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001153 return converterr("(unspecified)", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001154 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001155 FETCH_SIZE;
1156 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001157 format++;
1158 }
1159 break;
1160 }
1161
1162 case 't': { /* 8-bit character buffer, read-only access */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001163 char **p = va_arg(*p_va, char **);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001164 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001165 int count;
1166
1167 if (*format++ != '#')
1168 return converterr(
1169 "invalid use of 't' format character",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001170 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001171 if (!PyType_HasFeature(arg->ob_type,
Jeremy Hylton4819e972001-10-11 14:40:37 +00001172 Py_TPFLAGS_HAVE_GETCHARBUFFER) ||
1173 pb == NULL || pb->bf_getcharbuffer == NULL ||
1174 pb->bf_getsegcount == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001175 return converterr(
1176 "string or read-only character buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001177 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001178
Jeremy Hylton4819e972001-10-11 14:40:37 +00001179 if (pb->bf_getsegcount(arg, NULL) != 1)
1180 return converterr(
1181 "string or single-segment read-only buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001182 arg, msgbuf, bufsize);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001183
1184 count = pb->bf_getcharbuffer(arg, 0, p);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001185 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001186 return converterr("(unspecified)", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001187 {
1188 FETCH_SIZE;
1189 STORE_SIZE(count);
1190 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001191 break;
1192 }
1193
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001194 default:
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001195 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001196
1197 }
1198
1199 *p_format = format;
1200 return NULL;
1201}
Guido van Rossumaa354651996-08-19 19:32:04 +00001202
Martin v. Löwis18e16552006-02-15 17:27:45 +00001203static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001204convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001205{
1206 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001207 Py_ssize_t count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001208 if (pb == NULL ||
1209 pb->bf_getreadbuffer == NULL ||
1210 pb->bf_getsegcount == NULL) {
1211 *errmsg = "string or read-only buffer";
1212 return -1;
1213 }
1214 if ((*pb->bf_getsegcount)(arg, NULL) != 1) {
1215 *errmsg = "string or single-segment read-only buffer";
1216 return -1;
1217 }
1218 if ((count = (*pb->bf_getreadbuffer)(arg, 0, p)) < 0) {
1219 *errmsg = "(unspecified)";
1220 }
1221 return count;
1222}
Guido van Rossumaa354651996-08-19 19:32:04 +00001223
1224/* Support for keyword arguments donated by
1225 Geoff Philbrick <philbric@delphi.hks.com> */
1226
Tim Petersf8cd3e82001-10-27 04:26:57 +00001227/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001228int
1229PyArg_ParseTupleAndKeywords(PyObject *args,
1230 PyObject *keywords,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001231 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001232 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001233{
1234 int retval;
1235 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001236
1237 if ((args == NULL || !PyTuple_Check(args)) ||
1238 (keywords != NULL && !PyDict_Check(keywords)) ||
1239 format == NULL ||
1240 kwlist == NULL)
1241 {
1242 PyErr_BadInternalCall();
Tim Petersf8cd3e82001-10-27 04:26:57 +00001243 return 0;
Tim Peters45772cd2001-10-27 03:58:40 +00001244 }
1245
Guido van Rossumaa354651996-08-19 19:32:04 +00001246 va_start(va, kwlist);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001247 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1248 va_end(va);
1249 return retval;
1250}
1251
1252int
1253_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1254 PyObject *keywords,
1255 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001256 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001257{
1258 int retval;
1259 va_list va;
1260
1261 if ((args == NULL || !PyTuple_Check(args)) ||
1262 (keywords != NULL && !PyDict_Check(keywords)) ||
1263 format == NULL ||
1264 kwlist == NULL)
1265 {
1266 PyErr_BadInternalCall();
1267 return 0;
1268 }
1269
1270 va_start(va, kwlist);
1271 retval = vgetargskeywords(args, keywords, format,
1272 kwlist, &va, FLAG_SIZE_T);
Guido van Rossumaa354651996-08-19 19:32:04 +00001273 va_end(va);
1274 return retval;
1275}
1276
1277
Brett Cannon711e7d92004-07-10 22:20:32 +00001278int
1279PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001280 PyObject *keywords,
1281 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001282 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001283{
1284 int retval;
1285 va_list lva;
1286
1287 if ((args == NULL || !PyTuple_Check(args)) ||
1288 (keywords != NULL && !PyDict_Check(keywords)) ||
1289 format == NULL ||
1290 kwlist == NULL)
1291 {
1292 PyErr_BadInternalCall();
1293 return 0;
1294 }
1295
1296#ifdef VA_LIST_IS_ARRAY
1297 memcpy(lva, va, sizeof(va_list));
1298#else
1299#ifdef __va_copy
1300 __va_copy(lva, va);
1301#else
1302 lva = va;
1303#endif
1304#endif
1305
Martin v. Löwis18e16552006-02-15 17:27:45 +00001306 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1307 return retval;
1308}
1309
1310int
1311_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1312 PyObject *keywords,
1313 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001314 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001315{
1316 int retval;
1317 va_list lva;
1318
1319 if ((args == NULL || !PyTuple_Check(args)) ||
1320 (keywords != NULL && !PyDict_Check(keywords)) ||
1321 format == NULL ||
1322 kwlist == NULL)
1323 {
1324 PyErr_BadInternalCall();
1325 return 0;
1326 }
1327
1328#ifdef VA_LIST_IS_ARRAY
1329 memcpy(lva, va, sizeof(va_list));
1330#else
1331#ifdef __va_copy
1332 __va_copy(lva, va);
1333#else
1334 lva = va;
1335#endif
1336#endif
1337
1338 retval = vgetargskeywords(args, keywords, format,
1339 kwlist, &lva, FLAG_SIZE_T);
Brett Cannon711e7d92004-07-10 22:20:32 +00001340 return retval;
1341}
1342
1343
Guido van Rossumaa354651996-08-19 19:32:04 +00001344static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001345vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001346 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001347{
Tim Petersdc5eff92001-10-27 06:53:00 +00001348 char msgbuf[512];
Guido van Rossumaa354651996-08-19 19:32:04 +00001349 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001350 const char *fname, *message;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001351 int min, max;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001352 const char *formatsave;
Tim Petersb639d492001-10-27 07:00:56 +00001353 int i, len, nargs, nkeywords;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001354 const char *msg;
1355 char **p;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001356 PyObject *freelist = NULL;
Tim Petersf4331c12001-10-27 00:17:34 +00001357
Tim Peters45772cd2001-10-27 03:58:40 +00001358 assert(args != NULL && PyTuple_Check(args));
1359 assert(keywords == NULL || PyDict_Check(keywords));
1360 assert(format != NULL);
1361 assert(kwlist != NULL);
1362 assert(p_va != NULL);
1363
Tim Petersf8cd3e82001-10-27 04:26:57 +00001364 /* Search the format:
1365 message <- error msg, if any (else NULL).
Tim Peterscffed4b2001-11-29 03:26:37 +00001366 fname <- routine name, if any (else NULL).
Tim Petersf8cd3e82001-10-27 04:26:57 +00001367 min <- # of required arguments, or -1 if all are required.
1368 max <- most arguments (required + optional).
Tim Peters62d48e12001-10-27 06:42:16 +00001369 Check that kwlist has a non-NULL entry for each arg.
Tim Petersf8cd3e82001-10-27 04:26:57 +00001370 Raise error if a tuple arg spec is found.
1371 */
1372 fname = message = NULL;
Tim Peters6fb26352001-10-27 04:38:11 +00001373 formatsave = format;
Tim Peters62d48e12001-10-27 06:42:16 +00001374 p = kwlist;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001375 min = -1;
1376 max = 0;
1377 while ((i = *format++) != '\0') {
Neal Norwitz30b5c5d2005-12-19 06:05:18 +00001378 if (isalpha(Py_CHARMASK(i)) && i != 'e') {
Tim Petersf8cd3e82001-10-27 04:26:57 +00001379 max++;
Tim Peters62d48e12001-10-27 06:42:16 +00001380 if (*p == NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001381 PyErr_SetString(PyExc_RuntimeError,
1382 "more argument specifiers than "
1383 "keyword list entries");
Tim Peters62d48e12001-10-27 06:42:16 +00001384 return 0;
1385 }
1386 p++;
1387 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001388 else if (i == '|')
1389 min = max;
1390 else if (i == ':') {
1391 fname = format;
1392 break;
1393 }
1394 else if (i == ';') {
1395 message = format;
1396 break;
1397 }
1398 else if (i == '(') {
Tim Peterscffed4b2001-11-29 03:26:37 +00001399 PyErr_SetString(PyExc_RuntimeError,
1400 "tuple found in format when using keyword "
1401 "arguments");
Guido van Rossumaa354651996-08-19 19:32:04 +00001402 return 0;
1403 }
Tim Peters62d48e12001-10-27 06:42:16 +00001404 }
1405 format = formatsave;
1406 if (*p != NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001407 PyErr_SetString(PyExc_RuntimeError,
1408 "more keyword list entries than "
1409 "argument specifiers");
Tim Peters62d48e12001-10-27 06:42:16 +00001410 return 0;
1411 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001412 if (min < 0) {
1413 /* All arguments are required. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001414 min = max;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001415 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001416
Tim Peters6fb26352001-10-27 04:38:11 +00001417 nargs = PyTuple_GET_SIZE(args);
Tim Petersb0872fc2001-10-27 04:45:34 +00001418 nkeywords = keywords == NULL ? 0 : PyDict_Size(keywords);
Tim Petersf8cd3e82001-10-27 04:26:57 +00001419
Guido van Rossumaa354651996-08-19 19:32:04 +00001420 /* make sure there are no duplicate values for an argument;
1421 its not clear when to use the term "keyword argument vs.
1422 keyword parameter in messages */
Tim Petersb054be42001-10-27 05:07:41 +00001423 if (nkeywords > 0) {
Tim Peters6fb26352001-10-27 04:38:11 +00001424 for (i = 0; i < nargs; i++) {
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001425 const char *thiskw = kwlist[i];
Tim Petersa9f47392001-10-27 00:46:09 +00001426 if (thiskw == NULL)
1427 break;
Tim Peters077f5742001-10-27 05:50:39 +00001428 if (PyDict_GetItemString(keywords, thiskw)) {
Tim Petersb054be42001-10-27 05:07:41 +00001429 PyErr_Format(PyExc_TypeError,
1430 "keyword parameter '%s' was given "
1431 "by position and by name",
Tim Petersa9f47392001-10-27 00:46:09 +00001432 thiskw);
Guido van Rossumaa354651996-08-19 19:32:04 +00001433 return 0;
1434 }
Tim Peters0af49162001-10-27 06:14:32 +00001435 else if (PyErr_Occurred())
1436 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001437 }
1438 }
Tim Peters61dde632001-10-27 05:30:17 +00001439
Guido van Rossumaa354651996-08-19 19:32:04 +00001440 /* required arguments missing from args can be supplied by keyword
Georg Brandld7048172006-01-20 17:53:27 +00001441 arguments; set len to the number of positional arguments, and,
Tim Peters62d48e12001-10-27 06:42:16 +00001442 if that's less than the minimum required, add in the number of
1443 required arguments that are supplied by keywords */
Tim Peters6fb26352001-10-27 04:38:11 +00001444 len = nargs;
Tim Peters62d48e12001-10-27 06:42:16 +00001445 if (nkeywords > 0 && nargs < min) {
Tim Peters6fb26352001-10-27 04:38:11 +00001446 for (i = nargs; i < min; i++) {
Tim Peters077f5742001-10-27 05:50:39 +00001447 if (PyDict_GetItemString(keywords, kwlist[i]))
Guido van Rossumaa354651996-08-19 19:32:04 +00001448 len++;
Tim Peters0af49162001-10-27 06:14:32 +00001449 else if (PyErr_Occurred())
1450 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001451 }
1452 }
Tim Peters0af49162001-10-27 06:14:32 +00001453
Guido van Rossumaa354651996-08-19 19:32:04 +00001454 /* make sure we got an acceptable number of arguments; the message
1455 is a little confusing with keywords since keyword arguments
1456 which are supplied, but don't match the required arguments
Michael W. Hudson5253c302005-03-30 16:41:55 +00001457 are not included in the "%d given" part of the message
1458 XXX and this isn't a bug!? */
Guido van Rossumaa354651996-08-19 19:32:04 +00001459 if (len < min || max < len) {
1460 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +00001461 PyOS_snprintf(msgbuf, sizeof(msgbuf),
1462 "%.200s%s takes %s %d argument%s "
1463 "(%d given)",
1464 fname==NULL ? "function" : fname,
1465 fname==NULL ? "" : "()",
1466 min==max ? "exactly"
1467 : len < min ? "at least" : "at most",
1468 len < min ? min : max,
1469 (len < min ? min : max) == 1 ? "" : "s",
1470 len);
Guido van Rossumaa354651996-08-19 19:32:04 +00001471 message = msgbuf;
1472 }
1473 PyErr_SetString(PyExc_TypeError, message);
1474 return 0;
1475 }
Tim Petersc2f01122001-10-27 07:25:06 +00001476
1477 /* convert the positional arguments */
Tim Peters6fb26352001-10-27 04:38:11 +00001478 for (i = 0; i < nargs; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001479 if (*format == '|')
1480 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +00001481 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001482 flags, levels, msgbuf, sizeof(msgbuf),
1483 &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001484 if (msg) {
1485 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001486 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001487 }
1488 }
1489
Tim Petersc2f01122001-10-27 07:25:06 +00001490 /* handle no keyword parameters in call */
Tim Petersb054be42001-10-27 05:07:41 +00001491 if (nkeywords == 0)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001492 return cleanreturn(1, freelist);
Tim Petersb054be42001-10-27 05:07:41 +00001493
Guido van Rossumaa354651996-08-19 19:32:04 +00001494 /* convert the keyword arguments; this uses the format
1495 string where it was left after processing args */
Tim Petersb639d492001-10-27 07:00:56 +00001496 for (i = nargs; i < max; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001497 PyObject *item;
Guido van Rossumaa354651996-08-19 19:32:04 +00001498 if (*format == '|')
1499 format++;
Tim Peters077f5742001-10-27 05:50:39 +00001500 item = PyDict_GetItemString(keywords, kwlist[i]);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001501 if (item != NULL) {
Tim Peters077f5742001-10-27 05:50:39 +00001502 Py_INCREF(item);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001503 msg = convertitem(item, &format, p_va, flags, levels,
1504 msgbuf, sizeof(msgbuf), &freelist);
Tim Peters077f5742001-10-27 05:50:39 +00001505 Py_DECREF(item);
Guido van Rossumaa354651996-08-19 19:32:04 +00001506 if (msg) {
1507 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001508 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001509 }
Tim Petersc2f01122001-10-27 07:25:06 +00001510 --nkeywords;
1511 if (nkeywords == 0)
1512 break;
Guido van Rossumaa354651996-08-19 19:32:04 +00001513 }
Tim Peters0af49162001-10-27 06:14:32 +00001514 else if (PyErr_Occurred())
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001515 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001516 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001517 msg = skipitem(&format, p_va, flags);
Guido van Rossumaa354651996-08-19 19:32:04 +00001518 if (msg) {
Georg Brandl5f135782006-07-26 08:03:10 +00001519 levels[0] = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001520 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001521 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001522 }
1523 }
1524 }
Tim Petersb054be42001-10-27 05:07:41 +00001525
Guido van Rossumaa354651996-08-19 19:32:04 +00001526 /* make sure there are no extraneous keyword arguments */
Tim Petersc2f01122001-10-27 07:25:06 +00001527 if (nkeywords > 0) {
1528 PyObject *key, *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001529 Py_ssize_t pos = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001530 while (PyDict_Next(keywords, &pos, &key, &value)) {
Tim Petersc2f01122001-10-27 07:25:06 +00001531 int match = 0;
Guido van Rossum55474762002-04-04 16:22:30 +00001532 char *ks;
1533 if (!PyString_Check(key)) {
1534 PyErr_SetString(PyExc_TypeError,
1535 "keywords must be strings");
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001536 return cleanreturn(0, freelist);
Guido van Rossum55474762002-04-04 16:22:30 +00001537 }
1538 ks = PyString_AsString(key);
Tim Petersb639d492001-10-27 07:00:56 +00001539 for (i = 0; i < max; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001540 if (!strcmp(ks, kwlist[i])) {
1541 match = 1;
1542 break;
1543 }
1544 }
1545 if (!match) {
Tim Petersc2f01122001-10-27 07:25:06 +00001546 PyErr_Format(PyExc_TypeError,
1547 "'%s' is an invalid keyword "
1548 "argument for this function",
1549 ks);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001550 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001551 }
1552 }
1553 }
Tim Petersc2f01122001-10-27 07:25:06 +00001554
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001555 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001556}
1557
1558
1559static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001560skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001561{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001562 const char *format = *p_format;
Guido van Rossumaa354651996-08-19 19:32:04 +00001563 char c = *format++;
1564
1565 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001566
1567 /* simple codes
1568 * The individual types (second arg of va_arg) are irrelevant */
1569
Guido van Rossumaa354651996-08-19 19:32:04 +00001570 case 'b': /* byte -- very short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001571 case 'B': /* byte as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001572 case 'h': /* short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001573 case 'H': /* short int as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001574 case 'i': /* int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001575 case 'I': /* int sized bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001576 case 'l': /* long int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001577 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001578#ifdef HAVE_LONG_LONG
Georg Brandl6dd14612005-09-14 19:29:53 +00001579 case 'L': /* PY_LONG_LONG */
1580 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001581#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001582 case 'f': /* float */
Guido van Rossumaa354651996-08-19 19:32:04 +00001583 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001584#ifndef WITHOUT_COMPLEX
1585 case 'D': /* complex double */
Georg Brandl6dd14612005-09-14 19:29:53 +00001586#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001587 case 'c': /* char */
1588 {
Georg Brandl6dd14612005-09-14 19:29:53 +00001589 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001590 break;
1591 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001592
1593 case 'n': /* Py_ssize_t */
1594 {
1595 (void) va_arg(*p_va, Py_ssize_t *);
1596 break;
1597 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001598
Georg Brandl6dd14612005-09-14 19:29:53 +00001599 /* string codes */
1600
1601 case 'e': /* string with encoding */
1602 {
1603 (void) va_arg(*p_va, const char *);
1604 if (!(*format == 's' || *format == 't'))
1605 /* after 'e', only 's' and 't' is allowed */
1606 goto err;
1607 format++;
1608 /* explicit fallthrough to string cases */
1609 }
1610
Guido van Rossumaa354651996-08-19 19:32:04 +00001611 case 's': /* string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001612 case 'z': /* string or None */
1613#ifdef Py_USING_UNICODE
1614 case 'u': /* unicode string */
1615#endif
1616 case 't': /* buffer, read-only */
1617 case 'w': /* buffer, read-write */
Guido van Rossumaa354651996-08-19 19:32:04 +00001618 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001619 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001620 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001621 if (flags & FLAG_SIZE_T)
1622 (void) va_arg(*p_va, Py_ssize_t *);
1623 else
1624 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001625 format++;
1626 }
1627 break;
1628 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001629
1630 /* object codes */
1631
Guido van Rossumaa354651996-08-19 19:32:04 +00001632 case 'S': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001633#ifdef Py_USING_UNICODE
1634 case 'U': /* unicode string object */
1635#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001636 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001637 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001638 break;
1639 }
1640
1641 case 'O': /* object */
1642 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001643 if (*format == '!') {
1644 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001645 (void) va_arg(*p_va, PyTypeObject*);
1646 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001647 }
1648#if 0
1649/* I don't know what this is for */
1650 else if (*format == '?') {
1651 inquiry pred = va_arg(*p_va, inquiry);
1652 format++;
1653 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001654 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001655 }
1656 }
1657#endif
1658 else if (*format == '&') {
Tim Petersdbd9ba62000-07-09 03:09:57 +00001659 typedef int (*converter)(PyObject *, void *);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001660 (void) va_arg(*p_va, converter);
1661 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001662 format++;
1663 }
1664 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001665 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001666 }
1667 break;
1668 }
1669
1670 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001671err:
Guido van Rossumaa354651996-08-19 19:32:04 +00001672 return "impossible<bad format char>";
1673
1674 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001675
1676 /* The "(...)" format code for tuples is not handled here because
1677 * it is not allowed with keyword args. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001678
1679 *p_format = format;
1680 return NULL;
1681}
Fred Drakee4616e62001-10-23 21:09:29 +00001682
1683
1684int
Martin v. Löwis76246742006-03-01 04:06:10 +00001685PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001686{
Martin v. Löwis76246742006-03-01 04:06:10 +00001687 Py_ssize_t i, l;
Fred Drakee4616e62001-10-23 21:09:29 +00001688 PyObject **o;
1689 va_list vargs;
1690
1691#ifdef HAVE_STDARG_PROTOTYPES
1692 va_start(vargs, max);
1693#else
1694 va_start(vargs);
1695#endif
1696
1697 assert(min >= 0);
1698 assert(min <= max);
1699 if (!PyTuple_Check(args)) {
1700 PyErr_SetString(PyExc_SystemError,
1701 "PyArg_UnpackTuple() argument list is not a tuple");
1702 return 0;
1703 }
1704 l = PyTuple_GET_SIZE(args);
1705 if (l < min) {
1706 if (name != NULL)
1707 PyErr_Format(
1708 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001709 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001710 name, (min == max ? "" : "at least "), min, l);
1711 else
1712 PyErr_Format(
1713 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001714 "unpacked tuple should have %s%zd elements,"
1715 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001716 (min == max ? "" : "at least "), min, l);
1717 va_end(vargs);
1718 return 0;
1719 }
1720 if (l > max) {
1721 if (name != NULL)
1722 PyErr_Format(
1723 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001724 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001725 name, (min == max ? "" : "at most "), max, l);
1726 else
1727 PyErr_Format(
1728 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001729 "unpacked tuple should have %s%zd elements,"
1730 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001731 (min == max ? "" : "at most "), max, l);
1732 va_end(vargs);
1733 return 0;
1734 }
1735 for (i = 0; i < l; i++) {
1736 o = va_arg(vargs, PyObject **);
1737 *o = PyTuple_GET_ITEM(args, i);
1738 }
1739 va_end(vargs);
1740 return 1;
1741}
Georg Brandl02c42872005-08-26 06:42:30 +00001742
1743
1744/* For type constructors that don't take keyword args
1745 *
1746 * Sets a TypeError and returns 0 if the kwds dict is
1747 * not emtpy, returns 1 otherwise
1748 */
1749int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001750_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001751{
1752 if (kw == NULL)
1753 return 1;
1754 if (!PyDict_CheckExact(kw)) {
1755 PyErr_BadInternalCall();
1756 return 0;
1757 }
1758 if (PyDict_Size(kw) == 0)
1759 return 1;
1760
1761 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1762 funcname);
1763 return 0;
1764}
Anthony Baxter97300382006-04-12 04:38:54 +00001765#ifdef __cplusplus
1766};
1767#endif