blob: f5e21546fc1fd4de0fd9dfce169c905e9265fa70 [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);
Marc-André Lemburgd4c0a9c2001-11-28 11:47:00 +0000354 while (levels[i] > 0 && (int)(p-buf) < 220) {
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000355 PyOS_snprintf(p, sizeof(buf) - (buf - p),
356 ", 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);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000442 msg = convertitem(item, &format, p_va, flags, levels+1,
443 msgbuf, bufsize, freelist);
Guido van Rossum66368cc1999-02-17 23:16:43 +0000444 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
445 Py_XDECREF(item);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000446 if (msg != NULL) {
447 levels[0] = i+1;
448 return msg;
449 }
450 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000451
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000452 *p_format = format;
453 return NULL;
454}
455
456
457/* Convert a single item. */
458
459static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000460convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
461 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000462{
463 char *msg;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000464 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000465
466 if (*format == '(' /* ')' */) {
467 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000468 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000469 bufsize, 0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000470 if (msg == NULL)
471 format++;
472 }
473 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000474 msg = convertsimple(arg, &format, p_va, flags,
475 msgbuf, bufsize, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000476 if (msg != NULL)
477 levels[0] = 0;
478 }
479 if (msg == NULL)
480 *p_format = format;
481 return msg;
482}
483
484
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000485
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000486#define UNICODE_DEFAULT_ENCODING(arg) \
487 _PyUnicode_AsDefaultEncodedString(arg, NULL)
488
489/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000490
491static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000492converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000493{
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000494 assert(expected != NULL);
495 assert(arg != NULL);
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000496 PyOS_snprintf(msgbuf, bufsize,
497 "must be %.50s, not %.50s", expected,
498 arg == Py_None ? "None" : arg->ob_type->tp_name);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000499 return msgbuf;
500}
501
502#define CONV_UNICODE "(unicode conversion error)"
503
Neil Schemenauer5042da62003-02-04 20:59:40 +0000504/* explicitly check for float arguments when integers are expected. For now
505 * signal a warning. Returns true if an exception was raised. */
506static int
507float_argument_error(PyObject *arg)
508{
509 if (PyFloat_Check(arg) &&
510 PyErr_Warn(PyExc_DeprecationWarning,
511 "integer argument expected, got float" ))
512 return 1;
513 else
514 return 0;
515}
516
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000517/* Convert a non-tuple argument. Return NULL if conversion went OK,
518 or a string with a message describing the failure. The message is
519 formatted as "must be <desired type>, not <actual type>".
520 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000521 Don't call if a tuple is expected.
522
523 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000524*/
525
526static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000527convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000528 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000529{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000530 /* For # codes */
531#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
532 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
533 else q=va_arg(*p_va, int*);
534#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
535#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
536
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000537 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000538 char c = *format++;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000539#ifdef Py_USING_UNICODE
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000540 PyObject *uarg;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000541#endif
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000542
543 switch (c) {
544
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000545 case 'b': { /* unsigned byte -- very short int */
546 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000547 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000548 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000549 return converterr("integer<b>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000550 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000551 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000552 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000553 else if (ival < 0) {
554 PyErr_SetString(PyExc_OverflowError,
555 "unsigned byte integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000556 return converterr("integer<b>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000557 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000558 else if (ival > UCHAR_MAX) {
559 PyErr_SetString(PyExc_OverflowError,
560 "unsigned byte integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000561 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000562 }
563 else
564 *p = (unsigned char) ival;
565 break;
566 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000567
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000568 case 'B': {/* byte sized bitfield - both signed and unsigned
569 values allowed */
570 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000571 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000572 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000573 return converterr("integer<B>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000574 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000575 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000576 return converterr("integer<B>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000577 else
578 *p = (unsigned char) ival;
579 break;
580 }
Jack Jansencc22fbe2000-08-05 21:29:58 +0000581
Guido van Rossumfce26e72003-04-18 00:12:30 +0000582 case 'h': {/* signed short int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000583 short *p = va_arg(*p_va, short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000584 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000585 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000586 return converterr("integer<h>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000587 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000588 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000589 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfce26e72003-04-18 00:12:30 +0000590 else if (ival < SHRT_MIN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000591 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000592 "signed short integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000593 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000594 }
Guido van Rossumfce26e72003-04-18 00:12:30 +0000595 else if (ival > SHRT_MAX) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000596 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000597 "signed short integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000598 return converterr("integer<h>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000599 }
600 else
601 *p = (short) ival;
602 break;
603 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000604
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000605 case 'H': { /* short int sized bitfield, both signed and
606 unsigned allowed */
607 unsigned short *p = va_arg(*p_va, unsigned short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000608 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000609 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000610 return converterr("integer<H>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000611 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000612 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000613 return converterr("integer<H>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000614 else
615 *p = (unsigned short) ival;
616 break;
617 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000618
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000619 case 'i': {/* signed int */
620 int *p = va_arg(*p_va, int *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000621 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000622 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000623 return converterr("integer<i>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000624 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000625 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000626 return converterr("integer<i>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000627 else if (ival > INT_MAX) {
628 PyErr_SetString(PyExc_OverflowError,
629 "signed integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000630 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000631 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000632 else if (ival < INT_MIN) {
633 PyErr_SetString(PyExc_OverflowError,
634 "signed integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000635 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000636 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000637 else
638 *p = ival;
639 break;
640 }
641
Thomas Hellera4ea6032003-04-17 18:55:45 +0000642 case 'I': { /* int sized bitfield, both signed and
643 unsigned allowed */
644 unsigned int *p = va_arg(*p_va, unsigned int *);
645 unsigned int ival;
646 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000647 return converterr("integer<I>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000648 ival = PyInt_AsUnsignedLongMask(arg);
649 if (ival == -1 && PyErr_Occurred())
650 return converterr("integer<I>", arg, msgbuf, bufsize);
651 else
652 *p = ival;
653 break;
654 }
655
Martin v. Löwis18e16552006-02-15 17:27:45 +0000656 case 'n': /* Py_ssize_t */
657#if SIZEOF_SIZE_T != SIZEOF_LONG
658 {
659 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
660 Py_ssize_t ival;
661 if (float_argument_error(arg))
Georg Brandl7f573f72006-04-13 07:59:30 +0000662 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000663 ival = PyInt_AsSsize_t(arg);
664 if (ival == -1 && PyErr_Occurred())
Georg Brandl7f573f72006-04-13 07:59:30 +0000665 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000666 *p = ival;
667 break;
668 }
669#endif
670 /* Fall through from 'n' to 'l' if Py_ssize_t is int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000671 case 'l': {/* long int */
672 long *p = va_arg(*p_va, long *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000673 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000674 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000675 return converterr("integer<l>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000676 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000677 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000678 return converterr("integer<l>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000679 else
680 *p = ival;
681 break;
682 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000683
684 case 'k': { /* long sized bitfield */
685 unsigned long *p = va_arg(*p_va, unsigned long *);
686 unsigned long ival;
687 if (PyInt_Check(arg))
688 ival = PyInt_AsUnsignedLongMask(arg);
689 else if (PyLong_Check(arg))
690 ival = PyLong_AsUnsignedLongMask(arg);
691 else
692 return converterr("integer<k>", arg, msgbuf, bufsize);
693 *p = ival;
694 break;
695 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000696
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000697#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000698 case 'L': {/* PY_LONG_LONG */
699 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
700 PY_LONG_LONG ival = PyLong_AsLongLong( arg );
701 if( ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000702 return converterr("long<L>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000703 } else {
704 *p = ival;
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000705 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000706 break;
707 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000708
709 case 'K': { /* long long sized bitfield */
710 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
711 unsigned PY_LONG_LONG ival;
Thomas Hellera4ea6032003-04-17 18:55:45 +0000712 if (PyInt_Check(arg))
713 ival = PyInt_AsUnsignedLongMask(arg);
714 else if (PyLong_Check(arg))
715 ival = PyLong_AsUnsignedLongLongMask(arg);
716 else
717 return converterr("integer<K>", arg, msgbuf, bufsize);
718 *p = ival;
719 break;
720 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000721#endif
722
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000723 case 'f': {/* float */
724 float *p = va_arg(*p_va, float *);
725 double dval = PyFloat_AsDouble(arg);
726 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000727 return converterr("float<f>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000728 else
729 *p = (float) dval;
730 break;
731 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000732
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000733 case 'd': {/* double */
734 double *p = va_arg(*p_va, double *);
735 double dval = PyFloat_AsDouble(arg);
736 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000737 return converterr("float<d>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000738 else
739 *p = dval;
740 break;
741 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000742
Guido van Rossum530956d1996-07-21 02:27:43 +0000743#ifndef WITHOUT_COMPLEX
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000744 case 'D': {/* complex double */
745 Py_complex *p = va_arg(*p_va, Py_complex *);
746 Py_complex cval;
747 cval = PyComplex_AsCComplex(arg);
748 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000749 return converterr("complex<D>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000750 else
751 *p = cval;
752 break;
753 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000754#endif /* WITHOUT_COMPLEX */
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000755
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000756 case 'c': {/* char */
757 char *p = va_arg(*p_va, char *);
758 if (PyString_Check(arg) && PyString_Size(arg) == 1)
Jeremy Hylton0407aea2001-10-10 02:51:57 +0000759 *p = PyString_AS_STRING(arg)[0];
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000760 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000761 return converterr("char", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000762 break;
763 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000764
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000765 case 's': {/* string */
766 if (*format == '#') {
767 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000768 FETCH_SIZE;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000769
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000770 if (PyString_Check(arg)) {
771 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000772 STORE_SIZE(PyString_GET_SIZE(arg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000773 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000774#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000775 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000776 uarg = UNICODE_DEFAULT_ENCODING(arg);
777 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000778 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000779 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000780 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000781 STORE_SIZE(PyString_GET_SIZE(uarg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000782 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000783#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000784 else { /* any buffer-like object */
785 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000786 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000787 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000788 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000789 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000790 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000791 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000792 } else {
793 char **p = va_arg(*p_va, char **);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000794
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000795 if (PyString_Check(arg))
796 *p = PyString_AS_STRING(arg);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000797#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000798 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000799 uarg = UNICODE_DEFAULT_ENCODING(arg);
800 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000801 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000802 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000803 *p = PyString_AS_STRING(uarg);
Marc-André Lemburg6f15e572001-05-02 17:16:16 +0000804 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000805#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000806 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000807 return converterr("string", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000808 if ((int)strlen(*p) != PyString_Size(arg))
809 return converterr("string without null bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000810 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000811 }
812 break;
813 }
814
815 case 'z': {/* string, may be NULL (None) */
816 if (*format == '#') { /* any buffer-like object */
817 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000818 FETCH_SIZE;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000819
820 if (arg == Py_None) {
821 *p = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000822 STORE_SIZE(0);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000823 }
824 else if (PyString_Check(arg)) {
825 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000826 STORE_SIZE(PyString_GET_SIZE(arg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000827 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000828#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000829 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000830 uarg = UNICODE_DEFAULT_ENCODING(arg);
831 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000832 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000833 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000834 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000835 STORE_SIZE(PyString_GET_SIZE(uarg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000836 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000837#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000838 else { /* any buffer-like object */
839 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000840 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000841 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000842 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000843 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000844 }
845 format++;
846 } else {
847 char **p = va_arg(*p_va, char **);
848
849 if (arg == Py_None)
850 *p = 0;
851 else if (PyString_Check(arg))
Jeremy Hyltona4c8cd72001-10-10 02:51:08 +0000852 *p = PyString_AS_STRING(arg);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000853#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000854 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000855 uarg = UNICODE_DEFAULT_ENCODING(arg);
856 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000857 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000858 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000859 *p = PyString_AS_STRING(uarg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000860 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000861#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000862 else
863 return converterr("string or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000864 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000865 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000866 FETCH_SIZE;
Thomas Woutersc3547a32006-03-01 21:31:21 +0000867 assert(0); /* XXX redundant with if-case */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000868 if (arg == Py_None)
869 *q = 0;
870 else
871 *q = PyString_Size(arg);
872 format++;
873 }
874 else if (*p != NULL &&
875 (int)strlen(*p) != PyString_Size(arg))
876 return converterr(
877 "string without null bytes or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000878 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000879 }
880 break;
881 }
882
883 case 'e': {/* encoded string */
884 char **buffer;
885 const char *encoding;
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000886 PyObject *s;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000887 int size, recode_strings;
888
889 /* Get 'e' parameter: the encoding name */
890 encoding = (const char *)va_arg(*p_va, const char *);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000891#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000892 if (encoding == NULL)
893 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000894#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000895
896 /* Get output buffer parameter:
897 's' (recode all objects via Unicode) or
898 't' (only recode non-string objects)
899 */
900 if (*format == 's')
901 recode_strings = 1;
902 else if (*format == 't')
903 recode_strings = 0;
904 else
905 return converterr(
906 "(unknown parser marker combination)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000907 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000908 buffer = (char **)va_arg(*p_va, char **);
909 format++;
910 if (buffer == NULL)
911 return converterr("(buffer is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000912 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000913
914 /* Encode object */
915 if (!recode_strings && PyString_Check(arg)) {
916 s = arg;
917 Py_INCREF(s);
918 }
919 else {
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000920#ifdef Py_USING_UNICODE
921 PyObject *u;
922
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000923 /* Convert object to Unicode */
924 u = PyUnicode_FromObject(arg);
925 if (u == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000926 return converterr(
927 "string or unicode or text buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000928 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000929
930 /* Encode object; use default error handling */
931 s = PyUnicode_AsEncodedString(u,
932 encoding,
933 NULL);
934 Py_DECREF(u);
935 if (s == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000936 return converterr("(encoding failed)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000937 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000938 if (!PyString_Check(s)) {
939 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000940 return converterr(
941 "(encoder failed to return a string)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000942 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000943 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000944#else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000945 return converterr("string<e>", arg, msgbuf, bufsize);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000946#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000947 }
948 size = PyString_GET_SIZE(s);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000949
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000950 /* Write output; output is guaranteed to be 0-terminated */
951 if (*format == '#') {
952 /* Using buffer length parameter '#':
953
954 - if *buffer is NULL, a new buffer of the
955 needed size is allocated and the data
956 copied into it; *buffer is updated to point
957 to the new buffer; the caller is
958 responsible for PyMem_Free()ing it after
959 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000960
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000961 - if *buffer is not NULL, the data is
962 copied to *buffer; *buffer_len has to be
963 set to the size of the buffer on input;
964 buffer overflow is signalled with an error;
965 buffer has to provide enough room for the
966 encoded string plus the trailing 0-byte
967
968 - in both cases, *buffer_len is updated to
969 the size of the buffer /excluding/ the
970 trailing 0-byte
971
972 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000973 FETCH_SIZE;
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000974
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000975 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000976 if (q == NULL && q2 == NULL) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000977 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000978 return converterr(
979 "(buffer_len is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000980 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000981 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000982 if (*buffer == NULL) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000983 *buffer = PyMem_NEW(char, size + 1);
984 if (*buffer == NULL) {
985 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000986 return converterr(
987 "(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000988 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000989 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000990 if(addcleanup(*buffer, freelist)) {
991 Py_DECREF(s);
992 return converterr(
993 "(cleanup problem)",
994 arg, msgbuf, bufsize);
995 }
Fred Drake25871c02000-05-03 15:17:02 +0000996 } else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000997 if (size + 1 > BUFFER_LEN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000998 Py_DECREF(s);
999 return converterr(
1000 "(buffer overflow)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001001 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001002 }
Fred Drake25871c02000-05-03 15:17:02 +00001003 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001004 memcpy(*buffer,
1005 PyString_AS_STRING(s),
1006 size + 1);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001007 STORE_SIZE(size);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001008 } else {
1009 /* Using a 0-terminated buffer:
1010
1011 - the encoded string has to be 0-terminated
1012 for this variant to work; if it is not, an
1013 error raised
Fred Drake25871c02000-05-03 15:17:02 +00001014
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001015 - a new buffer of the needed size is
1016 allocated and the data copied into it;
1017 *buffer is updated to point to the new
1018 buffer; the caller is responsible for
1019 PyMem_Free()ing it after usage
1020
1021 */
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001022 if ((int)strlen(PyString_AS_STRING(s)) != size) {
1023 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001024 return converterr(
1025 "(encoded string without NULL bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001026 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001027 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001028 *buffer = PyMem_NEW(char, size + 1);
1029 if (*buffer == NULL) {
1030 Py_DECREF(s);
1031 return converterr("(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001032 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001033 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001034 if(addcleanup(*buffer, freelist)) {
1035 Py_DECREF(s);
1036 return converterr("(cleanup problem)",
1037 arg, msgbuf, bufsize);
1038 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001039 memcpy(*buffer,
1040 PyString_AS_STRING(s),
1041 size + 1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001042 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001043 Py_DECREF(s);
1044 break;
1045 }
1046
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001047#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001048 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1049 if (*format == '#') { /* any buffer-like object */
1050 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001051 FETCH_SIZE;
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001052 if (PyUnicode_Check(arg)) {
1053 *p = PyUnicode_AS_UNICODE(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001054 STORE_SIZE(PyUnicode_GET_SIZE(arg));
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001055 }
1056 else {
Neal Norwitz61546162006-04-14 05:20:28 +00001057 return converterr("cannot convert raw buffers",
1058 arg, msgbuf, bufsize);
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001059 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001060 format++;
1061 } else {
1062 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossume826ef02000-03-10 23:02:17 +00001063 if (PyUnicode_Check(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001064 *p = PyUnicode_AS_UNICODE(arg);
1065 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001066 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001067 }
1068 break;
1069 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001070#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001071
1072 case 'S': { /* string object */
1073 PyObject **p = va_arg(*p_va, PyObject **);
1074 if (PyString_Check(arg))
1075 *p = arg;
1076 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001077 return converterr("string", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001078 break;
1079 }
1080
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001081#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001082 case 'U': { /* Unicode object */
1083 PyObject **p = va_arg(*p_va, PyObject **);
1084 if (PyUnicode_Check(arg))
1085 *p = arg;
1086 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001087 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001088 break;
1089 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001090#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001091
1092 case 'O': { /* object */
1093 PyTypeObject *type;
1094 PyObject **p;
1095 if (*format == '!') {
1096 type = va_arg(*p_va, PyTypeObject*);
1097 p = va_arg(*p_va, PyObject **);
1098 format++;
Guido van Rossumcbfc8552001-08-28 16:37:51 +00001099 if (PyType_IsSubtype(arg->ob_type, type))
Guido van Rossume826ef02000-03-10 23:02:17 +00001100 *p = arg;
1101 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001102 return converterr(type->tp_name, arg, msgbuf, bufsize);
Guido van Rossumfccfe891998-05-15 22:04:07 +00001103
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001104 }
1105 else if (*format == '?') {
1106 inquiry pred = va_arg(*p_va, inquiry);
1107 p = va_arg(*p_va, PyObject **);
1108 format++;
1109 if ((*pred)(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001110 *p = arg;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001111 else
1112 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001113 arg, msgbuf, bufsize);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001114
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001115 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001116 else if (*format == '&') {
1117 typedef int (*converter)(PyObject *, void *);
1118 converter convert = va_arg(*p_va, converter);
1119 void *addr = va_arg(*p_va, void *);
1120 format++;
1121 if (! (*convert)(arg, addr))
1122 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001123 arg, msgbuf, bufsize);
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001124 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001125 else {
1126 p = va_arg(*p_va, PyObject **);
1127 *p = arg;
1128 }
1129 break;
1130 }
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001131
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001132
1133 case 'w': { /* memory buffer, read-write access */
1134 void **p = va_arg(*p_va, void **);
1135 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1136 int count;
1137
1138 if (pb == NULL ||
1139 pb->bf_getwritebuffer == NULL ||
1140 pb->bf_getsegcount == NULL)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001141 return converterr("read-write buffer", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001142 if ((*pb->bf_getsegcount)(arg, NULL) != 1)
1143 return converterr("single-segment read-write buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001144 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001145 if ((count = pb->bf_getwritebuffer(arg, 0, p)) < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001146 return converterr("(unspecified)", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001147 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001148 FETCH_SIZE;
1149 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001150 format++;
1151 }
1152 break;
1153 }
1154
1155 case 't': { /* 8-bit character buffer, read-only access */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001156 char **p = va_arg(*p_va, char **);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001157 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001158 int count;
1159
1160 if (*format++ != '#')
1161 return converterr(
1162 "invalid use of 't' format character",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001163 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001164 if (!PyType_HasFeature(arg->ob_type,
Jeremy Hylton4819e972001-10-11 14:40:37 +00001165 Py_TPFLAGS_HAVE_GETCHARBUFFER) ||
1166 pb == NULL || pb->bf_getcharbuffer == NULL ||
1167 pb->bf_getsegcount == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001168 return converterr(
1169 "string or read-only character buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001170 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001171
Jeremy Hylton4819e972001-10-11 14:40:37 +00001172 if (pb->bf_getsegcount(arg, NULL) != 1)
1173 return converterr(
1174 "string or single-segment read-only buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001175 arg, msgbuf, bufsize);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001176
1177 count = pb->bf_getcharbuffer(arg, 0, p);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001178 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001179 return converterr("(unspecified)", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001180 {
1181 FETCH_SIZE;
1182 STORE_SIZE(count);
1183 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001184 break;
1185 }
1186
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001187 default:
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001188 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001189
1190 }
1191
1192 *p_format = format;
1193 return NULL;
1194}
Guido van Rossumaa354651996-08-19 19:32:04 +00001195
Martin v. Löwis18e16552006-02-15 17:27:45 +00001196static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001197convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001198{
1199 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001200 Py_ssize_t count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001201 if (pb == NULL ||
1202 pb->bf_getreadbuffer == NULL ||
1203 pb->bf_getsegcount == NULL) {
1204 *errmsg = "string or read-only buffer";
1205 return -1;
1206 }
1207 if ((*pb->bf_getsegcount)(arg, NULL) != 1) {
1208 *errmsg = "string or single-segment read-only buffer";
1209 return -1;
1210 }
1211 if ((count = (*pb->bf_getreadbuffer)(arg, 0, p)) < 0) {
1212 *errmsg = "(unspecified)";
1213 }
1214 return count;
1215}
Guido van Rossumaa354651996-08-19 19:32:04 +00001216
1217/* Support for keyword arguments donated by
1218 Geoff Philbrick <philbric@delphi.hks.com> */
1219
Tim Petersf8cd3e82001-10-27 04:26:57 +00001220/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001221int
1222PyArg_ParseTupleAndKeywords(PyObject *args,
1223 PyObject *keywords,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001224 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001225 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001226{
1227 int retval;
1228 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001229
1230 if ((args == NULL || !PyTuple_Check(args)) ||
1231 (keywords != NULL && !PyDict_Check(keywords)) ||
1232 format == NULL ||
1233 kwlist == NULL)
1234 {
1235 PyErr_BadInternalCall();
Tim Petersf8cd3e82001-10-27 04:26:57 +00001236 return 0;
Tim Peters45772cd2001-10-27 03:58:40 +00001237 }
1238
Guido van Rossumaa354651996-08-19 19:32:04 +00001239 va_start(va, kwlist);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001240 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1241 va_end(va);
1242 return retval;
1243}
1244
1245int
1246_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1247 PyObject *keywords,
1248 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001249 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001250{
1251 int retval;
1252 va_list va;
1253
1254 if ((args == NULL || !PyTuple_Check(args)) ||
1255 (keywords != NULL && !PyDict_Check(keywords)) ||
1256 format == NULL ||
1257 kwlist == NULL)
1258 {
1259 PyErr_BadInternalCall();
1260 return 0;
1261 }
1262
1263 va_start(va, kwlist);
1264 retval = vgetargskeywords(args, keywords, format,
1265 kwlist, &va, FLAG_SIZE_T);
Guido van Rossumaa354651996-08-19 19:32:04 +00001266 va_end(va);
1267 return retval;
1268}
1269
1270
Brett Cannon711e7d92004-07-10 22:20:32 +00001271int
1272PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001273 PyObject *keywords,
1274 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001275 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001276{
1277 int retval;
1278 va_list lva;
1279
1280 if ((args == NULL || !PyTuple_Check(args)) ||
1281 (keywords != NULL && !PyDict_Check(keywords)) ||
1282 format == NULL ||
1283 kwlist == NULL)
1284 {
1285 PyErr_BadInternalCall();
1286 return 0;
1287 }
1288
1289#ifdef VA_LIST_IS_ARRAY
1290 memcpy(lva, va, sizeof(va_list));
1291#else
1292#ifdef __va_copy
1293 __va_copy(lva, va);
1294#else
1295 lva = va;
1296#endif
1297#endif
1298
Martin v. Löwis18e16552006-02-15 17:27:45 +00001299 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1300 return retval;
1301}
1302
1303int
1304_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1305 PyObject *keywords,
1306 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001307 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001308{
1309 int retval;
1310 va_list lva;
1311
1312 if ((args == NULL || !PyTuple_Check(args)) ||
1313 (keywords != NULL && !PyDict_Check(keywords)) ||
1314 format == NULL ||
1315 kwlist == NULL)
1316 {
1317 PyErr_BadInternalCall();
1318 return 0;
1319 }
1320
1321#ifdef VA_LIST_IS_ARRAY
1322 memcpy(lva, va, sizeof(va_list));
1323#else
1324#ifdef __va_copy
1325 __va_copy(lva, va);
1326#else
1327 lva = va;
1328#endif
1329#endif
1330
1331 retval = vgetargskeywords(args, keywords, format,
1332 kwlist, &lva, FLAG_SIZE_T);
Brett Cannon711e7d92004-07-10 22:20:32 +00001333 return retval;
1334}
1335
1336
Guido van Rossumaa354651996-08-19 19:32:04 +00001337static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001338vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001339 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001340{
Tim Petersdc5eff92001-10-27 06:53:00 +00001341 char msgbuf[512];
Guido van Rossumaa354651996-08-19 19:32:04 +00001342 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001343 const char *fname, *message;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001344 int min, max;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001345 const char *formatsave;
Tim Petersb639d492001-10-27 07:00:56 +00001346 int i, len, nargs, nkeywords;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001347 const char *msg;
1348 char **p;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001349 PyObject *freelist = NULL;
Tim Petersf4331c12001-10-27 00:17:34 +00001350
Tim Peters45772cd2001-10-27 03:58:40 +00001351 assert(args != NULL && PyTuple_Check(args));
1352 assert(keywords == NULL || PyDict_Check(keywords));
1353 assert(format != NULL);
1354 assert(kwlist != NULL);
1355 assert(p_va != NULL);
1356
Tim Petersf8cd3e82001-10-27 04:26:57 +00001357 /* Search the format:
1358 message <- error msg, if any (else NULL).
Tim Peterscffed4b2001-11-29 03:26:37 +00001359 fname <- routine name, if any (else NULL).
Tim Petersf8cd3e82001-10-27 04:26:57 +00001360 min <- # of required arguments, or -1 if all are required.
1361 max <- most arguments (required + optional).
Tim Peters62d48e12001-10-27 06:42:16 +00001362 Check that kwlist has a non-NULL entry for each arg.
Tim Petersf8cd3e82001-10-27 04:26:57 +00001363 Raise error if a tuple arg spec is found.
1364 */
1365 fname = message = NULL;
Tim Peters6fb26352001-10-27 04:38:11 +00001366 formatsave = format;
Tim Peters62d48e12001-10-27 06:42:16 +00001367 p = kwlist;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001368 min = -1;
1369 max = 0;
1370 while ((i = *format++) != '\0') {
Neal Norwitz30b5c5d2005-12-19 06:05:18 +00001371 if (isalpha(Py_CHARMASK(i)) && i != 'e') {
Tim Petersf8cd3e82001-10-27 04:26:57 +00001372 max++;
Tim Peters62d48e12001-10-27 06:42:16 +00001373 if (*p == NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001374 PyErr_SetString(PyExc_RuntimeError,
1375 "more argument specifiers than "
1376 "keyword list entries");
Tim Peters62d48e12001-10-27 06:42:16 +00001377 return 0;
1378 }
1379 p++;
1380 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001381 else if (i == '|')
1382 min = max;
1383 else if (i == ':') {
1384 fname = format;
1385 break;
1386 }
1387 else if (i == ';') {
1388 message = format;
1389 break;
1390 }
1391 else if (i == '(') {
Tim Peterscffed4b2001-11-29 03:26:37 +00001392 PyErr_SetString(PyExc_RuntimeError,
1393 "tuple found in format when using keyword "
1394 "arguments");
Guido van Rossumaa354651996-08-19 19:32:04 +00001395 return 0;
1396 }
Tim Peters62d48e12001-10-27 06:42:16 +00001397 }
1398 format = formatsave;
1399 if (*p != NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001400 PyErr_SetString(PyExc_RuntimeError,
1401 "more keyword list entries than "
1402 "argument specifiers");
Tim Peters62d48e12001-10-27 06:42:16 +00001403 return 0;
1404 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001405 if (min < 0) {
1406 /* All arguments are required. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001407 min = max;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001408 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001409
Tim Peters6fb26352001-10-27 04:38:11 +00001410 nargs = PyTuple_GET_SIZE(args);
Tim Petersb0872fc2001-10-27 04:45:34 +00001411 nkeywords = keywords == NULL ? 0 : PyDict_Size(keywords);
Tim Petersf8cd3e82001-10-27 04:26:57 +00001412
Guido van Rossumaa354651996-08-19 19:32:04 +00001413 /* make sure there are no duplicate values for an argument;
1414 its not clear when to use the term "keyword argument vs.
1415 keyword parameter in messages */
Tim Petersb054be42001-10-27 05:07:41 +00001416 if (nkeywords > 0) {
Tim Peters6fb26352001-10-27 04:38:11 +00001417 for (i = 0; i < nargs; i++) {
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001418 const char *thiskw = kwlist[i];
Tim Petersa9f47392001-10-27 00:46:09 +00001419 if (thiskw == NULL)
1420 break;
Tim Peters077f5742001-10-27 05:50:39 +00001421 if (PyDict_GetItemString(keywords, thiskw)) {
Tim Petersb054be42001-10-27 05:07:41 +00001422 PyErr_Format(PyExc_TypeError,
1423 "keyword parameter '%s' was given "
1424 "by position and by name",
Tim Petersa9f47392001-10-27 00:46:09 +00001425 thiskw);
Guido van Rossumaa354651996-08-19 19:32:04 +00001426 return 0;
1427 }
Tim Peters0af49162001-10-27 06:14:32 +00001428 else if (PyErr_Occurred())
1429 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001430 }
1431 }
Tim Peters61dde632001-10-27 05:30:17 +00001432
Guido van Rossumaa354651996-08-19 19:32:04 +00001433 /* required arguments missing from args can be supplied by keyword
Georg Brandld7048172006-01-20 17:53:27 +00001434 arguments; set len to the number of positional arguments, and,
Tim Peters62d48e12001-10-27 06:42:16 +00001435 if that's less than the minimum required, add in the number of
1436 required arguments that are supplied by keywords */
Tim Peters6fb26352001-10-27 04:38:11 +00001437 len = nargs;
Tim Peters62d48e12001-10-27 06:42:16 +00001438 if (nkeywords > 0 && nargs < min) {
Tim Peters6fb26352001-10-27 04:38:11 +00001439 for (i = nargs; i < min; i++) {
Tim Peters077f5742001-10-27 05:50:39 +00001440 if (PyDict_GetItemString(keywords, kwlist[i]))
Guido van Rossumaa354651996-08-19 19:32:04 +00001441 len++;
Tim Peters0af49162001-10-27 06:14:32 +00001442 else if (PyErr_Occurred())
1443 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001444 }
1445 }
Tim Peters0af49162001-10-27 06:14:32 +00001446
Guido van Rossumaa354651996-08-19 19:32:04 +00001447 /* make sure we got an acceptable number of arguments; the message
1448 is a little confusing with keywords since keyword arguments
1449 which are supplied, but don't match the required arguments
Michael W. Hudson5253c302005-03-30 16:41:55 +00001450 are not included in the "%d given" part of the message
1451 XXX and this isn't a bug!? */
Guido van Rossumaa354651996-08-19 19:32:04 +00001452 if (len < min || max < len) {
1453 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +00001454 PyOS_snprintf(msgbuf, sizeof(msgbuf),
1455 "%.200s%s takes %s %d argument%s "
1456 "(%d given)",
1457 fname==NULL ? "function" : fname,
1458 fname==NULL ? "" : "()",
1459 min==max ? "exactly"
1460 : len < min ? "at least" : "at most",
1461 len < min ? min : max,
1462 (len < min ? min : max) == 1 ? "" : "s",
1463 len);
Guido van Rossumaa354651996-08-19 19:32:04 +00001464 message = msgbuf;
1465 }
1466 PyErr_SetString(PyExc_TypeError, message);
1467 return 0;
1468 }
Tim Petersc2f01122001-10-27 07:25:06 +00001469
1470 /* convert the positional arguments */
Tim Peters6fb26352001-10-27 04:38:11 +00001471 for (i = 0; i < nargs; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001472 if (*format == '|')
1473 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +00001474 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001475 flags, levels, msgbuf, sizeof(msgbuf),
1476 &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001477 if (msg) {
1478 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001479 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001480 }
1481 }
1482
Tim Petersc2f01122001-10-27 07:25:06 +00001483 /* handle no keyword parameters in call */
Tim Petersb054be42001-10-27 05:07:41 +00001484 if (nkeywords == 0)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001485 return cleanreturn(1, freelist);
Tim Petersb054be42001-10-27 05:07:41 +00001486
Guido van Rossumaa354651996-08-19 19:32:04 +00001487 /* convert the keyword arguments; this uses the format
1488 string where it was left after processing args */
Tim Petersb639d492001-10-27 07:00:56 +00001489 for (i = nargs; i < max; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001490 PyObject *item;
Guido van Rossumaa354651996-08-19 19:32:04 +00001491 if (*format == '|')
1492 format++;
Tim Peters077f5742001-10-27 05:50:39 +00001493 item = PyDict_GetItemString(keywords, kwlist[i]);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001494 if (item != NULL) {
Tim Peters077f5742001-10-27 05:50:39 +00001495 Py_INCREF(item);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001496 msg = convertitem(item, &format, p_va, flags, levels,
1497 msgbuf, sizeof(msgbuf), &freelist);
Tim Peters077f5742001-10-27 05:50:39 +00001498 Py_DECREF(item);
Guido van Rossumaa354651996-08-19 19:32:04 +00001499 if (msg) {
1500 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001501 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001502 }
Tim Petersc2f01122001-10-27 07:25:06 +00001503 --nkeywords;
1504 if (nkeywords == 0)
1505 break;
Guido van Rossumaa354651996-08-19 19:32:04 +00001506 }
Tim Peters0af49162001-10-27 06:14:32 +00001507 else if (PyErr_Occurred())
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001508 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001509 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001510 msg = skipitem(&format, p_va, flags);
Guido van Rossumaa354651996-08-19 19:32:04 +00001511 if (msg) {
1512 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001513 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001514 }
1515 }
1516 }
Tim Petersb054be42001-10-27 05:07:41 +00001517
Guido van Rossumaa354651996-08-19 19:32:04 +00001518 /* make sure there are no extraneous keyword arguments */
Tim Petersc2f01122001-10-27 07:25:06 +00001519 if (nkeywords > 0) {
1520 PyObject *key, *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001521 Py_ssize_t pos = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001522 while (PyDict_Next(keywords, &pos, &key, &value)) {
Tim Petersc2f01122001-10-27 07:25:06 +00001523 int match = 0;
Guido van Rossum55474762002-04-04 16:22:30 +00001524 char *ks;
1525 if (!PyString_Check(key)) {
1526 PyErr_SetString(PyExc_TypeError,
1527 "keywords must be strings");
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001528 return cleanreturn(0, freelist);
Guido van Rossum55474762002-04-04 16:22:30 +00001529 }
1530 ks = PyString_AsString(key);
Tim Petersb639d492001-10-27 07:00:56 +00001531 for (i = 0; i < max; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001532 if (!strcmp(ks, kwlist[i])) {
1533 match = 1;
1534 break;
1535 }
1536 }
1537 if (!match) {
Tim Petersc2f01122001-10-27 07:25:06 +00001538 PyErr_Format(PyExc_TypeError,
1539 "'%s' is an invalid keyword "
1540 "argument for this function",
1541 ks);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001542 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001543 }
1544 }
1545 }
Tim Petersc2f01122001-10-27 07:25:06 +00001546
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001547 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001548}
1549
1550
1551static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001552skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001553{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001554 const char *format = *p_format;
Guido van Rossumaa354651996-08-19 19:32:04 +00001555 char c = *format++;
1556
1557 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001558
1559 /* simple codes
1560 * The individual types (second arg of va_arg) are irrelevant */
1561
Guido van Rossumaa354651996-08-19 19:32:04 +00001562 case 'b': /* byte -- very short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001563 case 'B': /* byte as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001564 case 'h': /* short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001565 case 'H': /* short int as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001566 case 'i': /* int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001567 case 'I': /* int sized bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001568 case 'l': /* long int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001569 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001570#ifdef HAVE_LONG_LONG
Georg Brandl6dd14612005-09-14 19:29:53 +00001571 case 'L': /* PY_LONG_LONG */
1572 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001573#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001574 case 'f': /* float */
Guido van Rossumaa354651996-08-19 19:32:04 +00001575 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001576#ifndef WITHOUT_COMPLEX
1577 case 'D': /* complex double */
Georg Brandl6dd14612005-09-14 19:29:53 +00001578#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001579 case 'c': /* char */
1580 {
Georg Brandl6dd14612005-09-14 19:29:53 +00001581 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001582 break;
1583 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001584
1585 case 'n': /* Py_ssize_t */
1586 {
1587 (void) va_arg(*p_va, Py_ssize_t *);
1588 break;
1589 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001590
Georg Brandl6dd14612005-09-14 19:29:53 +00001591 /* string codes */
1592
1593 case 'e': /* string with encoding */
1594 {
1595 (void) va_arg(*p_va, const char *);
1596 if (!(*format == 's' || *format == 't'))
1597 /* after 'e', only 's' and 't' is allowed */
1598 goto err;
1599 format++;
1600 /* explicit fallthrough to string cases */
1601 }
1602
Guido van Rossumaa354651996-08-19 19:32:04 +00001603 case 's': /* string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001604 case 'z': /* string or None */
1605#ifdef Py_USING_UNICODE
1606 case 'u': /* unicode string */
1607#endif
1608 case 't': /* buffer, read-only */
1609 case 'w': /* buffer, read-write */
Guido van Rossumaa354651996-08-19 19:32:04 +00001610 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001611 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001612 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001613 if (flags & FLAG_SIZE_T)
1614 (void) va_arg(*p_va, Py_ssize_t *);
1615 else
1616 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001617 format++;
1618 }
1619 break;
1620 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001621
1622 /* object codes */
1623
Guido van Rossumaa354651996-08-19 19:32:04 +00001624 case 'S': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001625#ifdef Py_USING_UNICODE
1626 case 'U': /* unicode string object */
1627#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001628 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001629 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001630 break;
1631 }
1632
1633 case 'O': /* object */
1634 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001635 if (*format == '!') {
1636 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001637 (void) va_arg(*p_va, PyTypeObject*);
1638 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001639 }
1640#if 0
1641/* I don't know what this is for */
1642 else if (*format == '?') {
1643 inquiry pred = va_arg(*p_va, inquiry);
1644 format++;
1645 if ((*pred)(arg)) {
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 }
1649#endif
1650 else if (*format == '&') {
Tim Petersdbd9ba62000-07-09 03:09:57 +00001651 typedef int (*converter)(PyObject *, void *);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001652 (void) va_arg(*p_va, converter);
1653 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001654 format++;
1655 }
1656 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001657 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001658 }
1659 break;
1660 }
1661
1662 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001663err:
Guido van Rossumaa354651996-08-19 19:32:04 +00001664 return "impossible<bad format char>";
1665
1666 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001667
1668 /* The "(...)" format code for tuples is not handled here because
1669 * it is not allowed with keyword args. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001670
1671 *p_format = format;
1672 return NULL;
1673}
Fred Drakee4616e62001-10-23 21:09:29 +00001674
1675
1676int
Martin v. Löwis76246742006-03-01 04:06:10 +00001677PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001678{
Martin v. Löwis76246742006-03-01 04:06:10 +00001679 Py_ssize_t i, l;
Fred Drakee4616e62001-10-23 21:09:29 +00001680 PyObject **o;
1681 va_list vargs;
1682
1683#ifdef HAVE_STDARG_PROTOTYPES
1684 va_start(vargs, max);
1685#else
1686 va_start(vargs);
1687#endif
1688
1689 assert(min >= 0);
1690 assert(min <= max);
1691 if (!PyTuple_Check(args)) {
1692 PyErr_SetString(PyExc_SystemError,
1693 "PyArg_UnpackTuple() argument list is not a tuple");
1694 return 0;
1695 }
1696 l = PyTuple_GET_SIZE(args);
1697 if (l < min) {
1698 if (name != NULL)
1699 PyErr_Format(
1700 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001701 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001702 name, (min == max ? "" : "at least "), min, l);
1703 else
1704 PyErr_Format(
1705 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001706 "unpacked tuple should have %s%zd elements,"
1707 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001708 (min == max ? "" : "at least "), min, l);
1709 va_end(vargs);
1710 return 0;
1711 }
1712 if (l > max) {
1713 if (name != NULL)
1714 PyErr_Format(
1715 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001716 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001717 name, (min == max ? "" : "at most "), max, l);
1718 else
1719 PyErr_Format(
1720 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001721 "unpacked tuple should have %s%zd elements,"
1722 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001723 (min == max ? "" : "at most "), max, l);
1724 va_end(vargs);
1725 return 0;
1726 }
1727 for (i = 0; i < l; i++) {
1728 o = va_arg(vargs, PyObject **);
1729 *o = PyTuple_GET_ITEM(args, i);
1730 }
1731 va_end(vargs);
1732 return 1;
1733}
Georg Brandl02c42872005-08-26 06:42:30 +00001734
1735
1736/* For type constructors that don't take keyword args
1737 *
1738 * Sets a TypeError and returns 0 if the kwds dict is
1739 * not emtpy, returns 1 otherwise
1740 */
1741int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001742_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001743{
1744 if (kw == NULL)
1745 return 1;
1746 if (!PyDict_CheckExact(kw)) {
1747 PyErr_BadInternalCall();
1748 return 0;
1749 }
1750 if (PyDict_Size(kw) == 0)
1751 return 1;
1752
1753 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1754 funcname);
1755 return 0;
1756}
Anthony Baxter97300382006-04-12 04:38:54 +00001757#ifdef __cplusplus
1758};
1759#endif