blob: 584805e25e601b1d92acbde63c0bb51242f404c4 [file] [log] [blame]
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001
2/* New getargs implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00005
Guido van Rossumc1d50531996-08-21 23:38:24 +00006#include <ctype.h>
7
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00008
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00009#ifdef __cplusplus
Guido van Rossum98297ee2007-11-06 21:34:58 +000010extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000011#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000012int PyArg_Parse(PyObject *, const char *, ...);
13int PyArg_ParseTuple(PyObject *, const char *, ...);
14int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000015
Tim Petersdbd9ba62000-07-09 03:09:57 +000016int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000017 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000018int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000019 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000020
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000021#ifdef HAVE_DECLSPEC_DLL
22/* Export functions */
23PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, char *, ...);
24PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, char *, ...);
25PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
26 const char *, char **, ...);
27PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
28PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, char *, va_list);
29PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
30 const char *, char **, va_list);
31#endif
32
Martin v. Löwis18e16552006-02-15 17:27:45 +000033#define FLAG_COMPAT 1
34#define FLAG_SIZE_T 2
35
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000036
37/* Forward */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000038static int vgetargs1(PyObject *, const char *, va_list *, int);
39static void seterror(int, const char *, int *, const char *, const char *);
Guido van Rossum98297ee2007-11-06 21:34:58 +000040static char *convertitem(PyObject *, const char **, va_list *, int, int *,
Martin v. Löwis18e16552006-02-15 17:27:45 +000041 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 Rossum98297ee2007-11-06 21:34:58 +000057
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000058 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;
Guido van Rossum98297ee2007-11-06 21:34:58 +000069
Martin v. Löwis18e16552006-02-15 17:27:45 +000070 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 Rossum98297ee2007-11-06 21:34:58 +000082
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000083 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;
Guido van Rossum98297ee2007-11-06 21:34:58 +000094
Martin v. Löwis18e16552006-02-15 17:27:45 +000095 va_start(va, format);
96 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
97 va_end(va);
98 return retval;
99}
100
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000101
102int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000103PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000104{
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000105 va_list lva;
106
107#ifdef VA_LIST_IS_ARRAY
108 memcpy(lva, va, sizeof(va_list));
109#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000110#ifdef __va_copy
111 __va_copy(lva, va);
112#else
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000113 lva = va;
114#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000115#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000116
117 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000118}
119
Martin v. Löwis18e16552006-02-15 17:27:45 +0000120int
121_PyArg_VaParse_SizeT(PyObject *args, char *format, va_list va)
122{
123 va_list lva;
124
125#ifdef VA_LIST_IS_ARRAY
126 memcpy(lva, va, sizeof(va_list));
127#else
128#ifdef __va_copy
129 __va_copy(lva, va);
130#else
131 lva = va;
132#endif
133#endif
134
135 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
136}
137
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000138
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000139/* Handle cleanup of allocated memory in case of exception */
140
141static int
142addcleanup(void *ptr, PyObject **freelist)
143{
144 PyObject *cobj;
145 if (!*freelist) {
146 *freelist = PyList_New(0);
147 if (!*freelist) {
148 PyMem_FREE(ptr);
149 return -1;
150 }
151 }
152 cobj = PyCObject_FromVoidPtr(ptr, NULL);
153 if (!cobj) {
154 PyMem_FREE(ptr);
155 return -1;
156 }
157 if(PyList_Append(*freelist, cobj)) {
158 PyMem_FREE(ptr);
159 Py_DECREF(cobj);
160 return -1;
161 }
162 Py_DECREF(cobj);
163 return 0;
164}
165
166static int
167cleanreturn(int retval, PyObject *freelist)
168{
169 if(freelist) {
170 if((retval) == 0) {
Martin v. Löwisd96ee902006-02-16 14:37:16 +0000171 Py_ssize_t len = PyList_GET_SIZE(freelist), i;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000172 for (i = 0; i < len; i++)
173 PyMem_FREE(PyCObject_AsVoidPtr(
174 PyList_GET_ITEM(freelist, i)));
175 }
176 Py_DECREF(freelist);
177 }
178 return retval;
179}
180
181
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000182static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000183vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000184{
185 char msgbuf[256];
186 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000187 const char *fname = NULL;
188 const char *message = NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000189 int min = -1;
190 int max = 0;
191 int level = 0;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000192 int endfmt = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000193 const char *formatsave = format;
Martin v. Löwisd96ee902006-02-16 14:37:16 +0000194 Py_ssize_t i, len;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000195 char *msg;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000196 PyObject *freelist = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000197 int compat = flags & FLAG_COMPAT;
198
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000199 assert(compat || (args != (PyObject*)NULL));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000200 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000201
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000202 while (endfmt == 0) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000203 int c = *format++;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000204 switch (c) {
205 case '(':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000206 if (level == 0)
207 max++;
208 level++;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000209 if (level >= 30)
210 Py_FatalError("too many tuple nesting levels "
211 "in argument format string");
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000212 break;
213 case ')':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000214 if (level == 0)
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000215 Py_FatalError("excess ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000216 else
217 level--;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000218 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000219 case '\0':
220 endfmt = 1;
221 break;
222 case ':':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000223 fname = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000224 endfmt = 1;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000225 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000226 case ';':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000227 message = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000228 endfmt = 1;
229 break;
230 default:
231 if (level == 0) {
232 if (c == 'O')
233 max++;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000234 else if (isalpha(Py_CHARMASK(c))) {
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000235 if (c != 'e') /* skip encoded */
236 max++;
237 } else if (c == '|')
238 min = max;
239 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000240 break;
241 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000242 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000243
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000244 if (level != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000245 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000246
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000247 if (min < 0)
248 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000249
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000250 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000251
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000252 if (compat) {
253 if (max == 0) {
254 if (args == NULL)
255 return 1;
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000256 PyOS_snprintf(msgbuf, sizeof(msgbuf),
257 "%.200s%s takes no arguments",
258 fname==NULL ? "function" : fname,
259 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000260 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000261 return 0;
262 }
263 else if (min == 1 && max == 1) {
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000264 if (args == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000265 PyOS_snprintf(msgbuf, sizeof(msgbuf),
266 "%.200s%s takes at least one argument",
267 fname==NULL ? "function" : fname,
268 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000269 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000270 return 0;
271 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000272 msg = convertitem(args, &format, p_va, flags, levels,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000273 msgbuf, sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000274 if (msg == NULL)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000275 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000276 seterror(levels[0], msg, levels+1, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000277 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000278 }
279 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000280 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000281 "old style getargs format uses new features");
282 return 0;
283 }
284 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000285
Guido van Rossum79f25d91997-04-29 20:08:16 +0000286 if (!PyTuple_Check(args)) {
287 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000288 "new style getargs format but argument is not a tuple");
289 return 0;
290 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000291
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000292 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000293
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000294 if (len < min || max < len) {
295 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000296 PyOS_snprintf(msgbuf, sizeof(msgbuf),
297 "%.150s%s takes %s %d argument%s "
Neal Norwitz20dd93f2006-02-19 19:34:15 +0000298 "(%ld given)",
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000299 fname==NULL ? "function" : fname,
300 fname==NULL ? "" : "()",
301 min==max ? "exactly"
302 : len < min ? "at least" : "at most",
303 len < min ? min : max,
304 (len < min ? min : max) == 1 ? "" : "s",
Neal Norwitz9a276172006-02-20 18:57:39 +0000305 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000306 message = msgbuf;
307 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000308 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000309 return 0;
310 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000311
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000312 for (i = 0; i < len; i++) {
313 if (*format == '|')
314 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000315 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000316 flags, levels, msgbuf,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000317 sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000318 if (msg) {
319 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000320 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000321 }
322 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000323
Neal Norwitz4ac13df2005-12-19 06:10:07 +0000324 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
Guido van Rossum7d4f68c1997-12-19 04:25:23 +0000325 *format != '(' &&
Guido van Rossum231a41e1997-12-09 20:36:39 +0000326 *format != '|' && *format != ':' && *format != ';') {
327 PyErr_Format(PyExc_SystemError,
Guido van Rossum0d6b49e1998-01-19 22:22:44 +0000328 "bad format string: %.200s", formatsave);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000329 return cleanreturn(0, freelist);
Guido van Rossum231a41e1997-12-09 20:36:39 +0000330 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000331
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000332 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000333}
334
335
336
337static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000338seterror(int iarg, const char *msg, int *levels, const char *fname,
339 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000340{
Marc-André Lemburgd4c0a9c2001-11-28 11:47:00 +0000341 char buf[512];
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000342 int i;
343 char *p = buf;
344
Guido van Rossum79f25d91997-04-29 20:08:16 +0000345 if (PyErr_Occurred())
Guido van Rossum64fc6491995-01-21 14:09:37 +0000346 return;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000347 else if (message == NULL) {
348 if (fname != NULL) {
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000349 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000350 p += strlen(p);
351 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000352 if (iarg != 0) {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000353 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000354 "argument %d", iarg);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000355 i = 0;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000356 p += strlen(p);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000357 while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
358 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000359 ", item %d", levels[i]-1);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000360 p += strlen(p);
361 i++;
362 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000363 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000364 else {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000365 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
Ka-Ping Yee20579702001-01-15 22:14:16 +0000366 p += strlen(p);
367 }
Tim Petersfaad5ad2001-12-03 00:43:33 +0000368 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000369 message = buf;
370 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000371 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000372}
373
374
375/* Convert a tuple argument.
376 On entry, *p_format points to the character _after_ the opening '('.
377 On successful exit, *p_format points to the closing ')'.
378 If successful:
379 *p_format and *p_va are updated,
380 *levels and *msgbuf are untouched,
381 and NULL is returned.
382 If the argument is invalid:
383 *p_format is unchanged,
384 *p_va is undefined,
385 *levels is a 0-terminated list of item numbers,
386 *msgbuf contains an error message, whose format is:
Ka-Ping Yee20579702001-01-15 22:14:16 +0000387 "must be <typename1>, not <typename2>", where:
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000388 <typename1> is the name of the expected type, and
389 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000390 and msgbuf is returned.
391*/
392
393static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000394converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000395 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000396 PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000397{
398 int level = 0;
399 int n = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000400 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000401 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000402
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000403 for (;;) {
404 int c = *format++;
405 if (c == '(') {
406 if (level == 0)
407 n++;
408 level++;
409 }
410 else if (c == ')') {
411 if (level == 0)
412 break;
413 level--;
414 }
415 else if (c == ':' || c == ';' || c == '\0')
416 break;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000417 else if (level == 0 && isalpha(Py_CHARMASK(c)))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000418 n++;
419 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000420
Ka-Ping Yee20579702001-01-15 22:14:16 +0000421 if (!PySequence_Check(arg) || PyString_Check(arg)) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000422 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000423 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000424 toplevel ? "expected %d arguments, not %.50s" :
425 "must be %d-item sequence, not %.50s",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000426 n,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000427 arg == Py_None ? "None" : arg->ob_type->tp_name);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000428 return msgbuf;
429 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000430
Jeremy Hylton03657cf2000-07-12 13:05:33 +0000431 if ((i = PySequence_Size(arg)) != n) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000432 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000433 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000434 toplevel ? "expected %d arguments, not %d" :
435 "must be sequence of length %d, not %d",
436 n, i);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000437 return msgbuf;
438 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000439
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000440 format = *p_format;
441 for (i = 0; i < n; i++) {
442 char *msg;
Guido van Rossum66368cc1999-02-17 23:16:43 +0000443 PyObject *item;
444 item = PySequence_GetItem(arg, i);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000445 if (item == NULL) {
446 PyErr_Clear();
447 levels[0] = i+1;
448 levels[1] = 0;
449 strncpy(msgbuf, "is not retrievable", bufsize);
450 return msgbuf;
451 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000452 msg = convertitem(item, &format, p_va, flags, levels+1,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000453 msgbuf, bufsize, freelist);
Guido van Rossum66368cc1999-02-17 23:16:43 +0000454 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
455 Py_XDECREF(item);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000456 if (msg != NULL) {
457 levels[0] = i+1;
458 return msg;
459 }
460 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000461
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000462 *p_format = format;
463 return NULL;
464}
465
466
467/* Convert a single item. */
468
469static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000470convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
471 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000472{
473 char *msg;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000474 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000475
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000476 if (*format == '(' /* ')' */) {
477 format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000478 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000479 bufsize, 0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000480 if (msg == NULL)
481 format++;
482 }
483 else {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000484 msg = convertsimple(arg, &format, p_va, flags,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000485 msgbuf, bufsize, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000486 if (msg != NULL)
487 levels[0] = 0;
488 }
489 if (msg == NULL)
490 *p_format = format;
491 return msg;
492}
493
494
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000495
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000496#define UNICODE_DEFAULT_ENCODING(arg) \
497 _PyUnicode_AsDefaultEncodedString(arg, NULL)
498
499/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000500
501static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000502converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000503{
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000504 assert(expected != NULL);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000505 assert(arg != NULL);
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000506 PyOS_snprintf(msgbuf, bufsize,
507 "must be %.50s, not %.50s", expected,
508 arg == Py_None ? "None" : arg->ob_type->tp_name);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000509 return msgbuf;
510}
511
512#define CONV_UNICODE "(unicode conversion error)"
513
Guido van Rossum45aecf42006-03-15 04:58:47 +0000514/* Explicitly check for float arguments when integers are expected.
515 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000516static int
517float_argument_error(PyObject *arg)
518{
Guido van Rossum45aecf42006-03-15 04:58:47 +0000519 if (PyFloat_Check(arg)) {
520 PyErr_SetString(PyExc_TypeError,
521 "integer argument expected, got float" );
Neil Schemenauer5042da62003-02-04 20:59:40 +0000522 return 1;
Guido van Rossum45aecf42006-03-15 04:58:47 +0000523 }
Neil Schemenauer5042da62003-02-04 20:59:40 +0000524 else
525 return 0;
526}
527
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000528/* Convert a non-tuple argument. Return NULL if conversion went OK,
529 or a string with a message describing the failure. The message is
530 formatted as "must be <desired type>, not <actual type>".
531 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000532 Don't call if a tuple is expected.
533
534 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000535*/
536
537static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000538convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000539 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000540{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000541 /* For # codes */
542#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
543 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
544 else q=va_arg(*p_va, int*);
545#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
546#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
547
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000548 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000549 char c = *format++;
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000550 PyObject *uarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000551
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000552 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000553
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000554 case 'b': { /* unsigned byte -- very short int */
555 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000556 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000557 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000558 return converterr("integer<b>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000559 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000560 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000561 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000562 else if (ival < 0) {
563 PyErr_SetString(PyExc_OverflowError,
564 "unsigned byte integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000565 return converterr("integer<b>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000566 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000567 else if (ival > UCHAR_MAX) {
568 PyErr_SetString(PyExc_OverflowError,
569 "unsigned byte integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000570 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000571 }
572 else
573 *p = (unsigned char) ival;
574 break;
575 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000576
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000577 case 'B': {/* byte sized bitfield - both signed and unsigned
Guido van Rossum98297ee2007-11-06 21:34:58 +0000578 values allowed */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000579 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000580 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000581 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000582 return converterr("integer<B>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000583 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000584 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000585 return converterr("integer<B>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000586 else
587 *p = (unsigned char) ival;
588 break;
589 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000590
Guido van Rossumfce26e72003-04-18 00:12:30 +0000591 case 'h': {/* signed short int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000592 short *p = va_arg(*p_va, short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000593 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000594 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000595 return converterr("integer<h>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000596 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000597 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000598 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfce26e72003-04-18 00:12:30 +0000599 else if (ival < SHRT_MIN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000600 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000601 "signed short integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000602 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000603 }
Guido van Rossumfce26e72003-04-18 00:12:30 +0000604 else if (ival > SHRT_MAX) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000605 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000606 "signed short integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000607 return converterr("integer<h>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000608 }
609 else
610 *p = (short) ival;
611 break;
612 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000613
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000614 case 'H': { /* short int sized bitfield, both signed and
Guido van Rossum98297ee2007-11-06 21:34:58 +0000615 unsigned allowed */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000616 unsigned short *p = va_arg(*p_va, unsigned short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000617 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000618 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000619 return converterr("integer<H>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000620 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000621 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000622 return converterr("integer<H>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000623 else
624 *p = (unsigned short) ival;
625 break;
626 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000627
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000628 case 'i': {/* signed int */
629 int *p = va_arg(*p_va, int *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000630 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000631 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000632 return converterr("integer<i>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000633 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000634 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000635 return converterr("integer<i>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000636 else if (ival > INT_MAX) {
637 PyErr_SetString(PyExc_OverflowError,
638 "signed integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000639 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000640 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000641 else if (ival < INT_MIN) {
642 PyErr_SetString(PyExc_OverflowError,
643 "signed integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000644 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000645 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000646 else
647 *p = ival;
648 break;
649 }
650
Thomas Hellera4ea6032003-04-17 18:55:45 +0000651 case 'I': { /* int sized bitfield, both signed and
Guido van Rossum98297ee2007-11-06 21:34:58 +0000652 unsigned allowed */
Thomas Hellera4ea6032003-04-17 18:55:45 +0000653 unsigned int *p = va_arg(*p_va, unsigned int *);
654 unsigned int ival;
655 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000656 return converterr("integer<I>", arg, msgbuf, bufsize);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000657 ival = (unsigned int)PyInt_AsUnsignedLongMask(arg);
658 if (ival == (unsigned int)-1 && PyErr_Occurred())
Thomas Hellera4ea6032003-04-17 18:55:45 +0000659 return converterr("integer<I>", arg, msgbuf, bufsize);
660 else
661 *p = ival;
662 break;
663 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000664
Martin v. Löwis18e16552006-02-15 17:27:45 +0000665 case 'n': /* Py_ssize_t */
666#if SIZEOF_SIZE_T != SIZEOF_LONG
667 {
Neal Norwitzb879f572007-08-31 05:20:36 +0000668 PyObject *iobj;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000669 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
Neal Norwitzb879f572007-08-31 05:20:36 +0000670 Py_ssize_t ival = -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000671 if (float_argument_error(arg))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000672 return converterr("integer<n>", arg, msgbuf, bufsize);
Neal Norwitzb879f572007-08-31 05:20:36 +0000673 iobj = PyNumber_Index(arg);
674 if (iobj != NULL)
Neal Norwitz64fd6fb2007-08-31 05:32:33 +0000675 ival = PyInt_AsSsize_t(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000676 if (ival == -1 && PyErr_Occurred())
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000677 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000678 *p = ival;
679 break;
680 }
681#endif
682 /* Fall through from 'n' to 'l' if Py_ssize_t is int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000683 case 'l': {/* long int */
684 long *p = va_arg(*p_va, long *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000685 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000686 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000687 return converterr("integer<l>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000688 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000689 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000690 return converterr("integer<l>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000691 else
692 *p = ival;
693 break;
694 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000695
696 case 'k': { /* long sized bitfield */
697 unsigned long *p = va_arg(*p_va, unsigned long *);
698 unsigned long ival;
Georg Brandle1a0d112007-10-23 19:24:22 +0000699 if (PyLong_Check(arg))
Thomas Hellera4ea6032003-04-17 18:55:45 +0000700 ival = PyLong_AsUnsignedLongMask(arg);
701 else
702 return converterr("integer<k>", arg, msgbuf, bufsize);
703 *p = ival;
704 break;
705 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000706
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000707#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000708 case 'L': {/* PY_LONG_LONG */
709 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
710 PY_LONG_LONG ival = PyLong_AsLongLong( arg );
711 if( ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000712 return converterr("long<L>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000713 } else {
714 *p = ival;
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000715 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000716 break;
717 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000718
719 case 'K': { /* long long sized bitfield */
720 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
721 unsigned PY_LONG_LONG ival;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000722 if (PyLong_Check(arg))
Thomas Hellera4ea6032003-04-17 18:55:45 +0000723 ival = PyLong_AsUnsignedLongLongMask(arg);
724 else
725 return converterr("integer<K>", arg, msgbuf, bufsize);
726 *p = ival;
727 break;
728 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000729#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000730
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000731 case 'f': {/* float */
732 float *p = va_arg(*p_va, float *);
733 double dval = PyFloat_AsDouble(arg);
734 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000735 return converterr("float<f>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000736 else
737 *p = (float) dval;
738 break;
739 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000740
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000741 case 'd': {/* double */
742 double *p = va_arg(*p_va, double *);
743 double dval = PyFloat_AsDouble(arg);
744 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000745 return converterr("float<d>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000746 else
747 *p = dval;
748 break;
749 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000750
Guido van Rossum530956d1996-07-21 02:27:43 +0000751#ifndef WITHOUT_COMPLEX
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000752 case 'D': {/* complex double */
753 Py_complex *p = va_arg(*p_va, Py_complex *);
754 Py_complex cval;
755 cval = PyComplex_AsCComplex(arg);
756 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000757 return converterr("complex<D>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000758 else
759 *p = cval;
760 break;
761 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000762#endif /* WITHOUT_COMPLEX */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000763
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000764 case 'c': {/* char */
Walter Dörwaldd0941302007-07-01 21:58:22 +0000765 char *p = va_arg(*p_va, char *);
766 if (PyString_Check(arg) && PyString_Size(arg) == 1)
767 *p = PyString_AS_STRING(arg)[0];
768 else if (PyUnicode_Check(arg) &&
769 PyUnicode_GET_SIZE(arg) == 1 &&
770 PyUnicode_AS_UNICODE(arg)[0] < 256)
Amaury Forgeot d'Arc39599dc2007-11-22 02:48:12 +0000771 *p = (char)PyUnicode_AS_UNICODE(arg)[0];
Walter Dörwaldd0941302007-07-01 21:58:22 +0000772 else
773 return converterr("char < 256", arg, msgbuf, bufsize);
774 break;
775 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000776
Walter Dörwaldd0941302007-07-01 21:58:22 +0000777 case 'C': {/* unicode char */
Walter Dörwaldbc1f8862007-06-20 11:02:38 +0000778 int *p = va_arg(*p_va, int *);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000779 if (PyString_Check(arg) && PyString_Size(arg) == 1)
Jeremy Hylton0407aea2001-10-10 02:51:57 +0000780 *p = PyString_AS_STRING(arg)[0];
Guido van Rossum09dc34f2007-05-04 04:17:33 +0000781 else if (PyUnicode_Check(arg) &&
Walter Dörwaldbc1f8862007-06-20 11:02:38 +0000782 PyUnicode_GET_SIZE(arg) == 1)
Guido van Rossum09dc34f2007-05-04 04:17:33 +0000783 *p = PyUnicode_AS_UNICODE(arg)[0];
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000784 else
Walter Dörwaldbc1f8862007-06-20 11:02:38 +0000785 return converterr("char", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000786 break;
787 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000788
789 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w', 't' codes all
790 need to be cleaned up! */
791
792 case 's': {/* text string */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000793 if (*format == '#') {
794 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000795 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000796
797 if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000798 uarg = UNICODE_DEFAULT_ENCODING(arg);
799 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000800 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000801 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000802 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000803 STORE_SIZE(PyString_GET_SIZE(uarg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000804 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000805 else { /* any buffer-like object */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000806 /* XXX Really? */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000807 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000808 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000809 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000810 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000811 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000812 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000813 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000814 } else {
815 char **p = va_arg(*p_va, char **);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000816
817 if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000818 uarg = UNICODE_DEFAULT_ENCODING(arg);
819 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000820 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000821 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000822 *p = PyString_AS_STRING(uarg);
Marc-André Lemburg6f15e572001-05-02 17:16:16 +0000823 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000824 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000825 return converterr("string", arg, msgbuf, bufsize);
Amaury Forgeot d'Arc39599dc2007-11-22 02:48:12 +0000826 if ((Py_ssize_t)strlen(*p) != PyUnicode_GetSize(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000827 return converterr("string without null bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000828 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000829 }
830 break;
831 }
832
Guido van Rossum98297ee2007-11-06 21:34:58 +0000833 case 'y': {/* any buffer-like object, but not PyUnicode */
834 void **p = (void **)va_arg(*p_va, char **);
835 char *buf;
836 Py_ssize_t count = convertbuffer(arg, p, &buf);
837 if (count < 0)
838 return converterr(buf, arg, msgbuf, bufsize);
Walter Dörwald612344f2007-05-04 19:28:21 +0000839 if (*format == '#') {
Walter Dörwald612344f2007-05-04 19:28:21 +0000840 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000841 STORE_SIZE(count);
Walter Dörwald612344f2007-05-04 19:28:21 +0000842 format++;
Walter Dörwald612344f2007-05-04 19:28:21 +0000843 }
844 break;
845 }
846
Guido van Rossum98297ee2007-11-06 21:34:58 +0000847 case 'z': {/* like 's' or 's#', but None is okay, stored as NULL */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000848 if (*format == '#') { /* any buffer-like object */
849 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000850 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000851
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000852 if (arg == Py_None) {
853 *p = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000854 STORE_SIZE(0);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000855 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000856 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000857 uarg = UNICODE_DEFAULT_ENCODING(arg);
858 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000859 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000860 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000861 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000862 STORE_SIZE(PyString_GET_SIZE(uarg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000863 }
864 else { /* any buffer-like object */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000865 /* XXX Really? */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000866 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000867 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000868 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000869 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000870 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000871 }
872 format++;
873 } else {
874 char **p = va_arg(*p_va, char **);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000875
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000876 if (arg == Py_None)
877 *p = 0;
878 else if (PyString_Check(arg))
Jeremy Hyltona4c8cd72001-10-10 02:51:08 +0000879 *p = PyString_AS_STRING(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000880 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000881 uarg = UNICODE_DEFAULT_ENCODING(arg);
882 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000883 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000884 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000885 *p = PyString_AS_STRING(uarg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000886 }
887 else
Guido van Rossum98297ee2007-11-06 21:34:58 +0000888 return converterr("string or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000889 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000890 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000891 FETCH_SIZE;
Thomas Woutersc3547a32006-03-01 21:31:21 +0000892 assert(0); /* XXX redundant with if-case */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000893 if (arg == Py_None) {
894 STORE_SIZE(0);
895 }
896 else {
897 STORE_SIZE(PyString_Size(arg));
898 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000899 format++;
900 }
901 else if (*p != NULL &&
Amaury Forgeot d'Arc39599dc2007-11-22 02:48:12 +0000902 (Py_ssize_t)strlen(*p) != PyUnicode_GetSize(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000903 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +0000904 "string without null bytes or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000905 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000906 }
907 break;
908 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000909
Guido van Rossumfb67be22007-08-29 18:38:11 +0000910 case 'Z': {/* unicode, may be NULL (None) */
911 if (*format == '#') { /* any buffer-like object */
912 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
913 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000914
Guido van Rossumfb67be22007-08-29 18:38:11 +0000915 if (arg == Py_None) {
916 *p = 0;
917 STORE_SIZE(0);
918 }
919 else if (PyUnicode_Check(arg)) {
920 *p = PyUnicode_AS_UNICODE(arg);
921 STORE_SIZE(PyUnicode_GET_SIZE(arg));
922 }
923 format++;
924 } else {
925 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000926
Guido van Rossumfb67be22007-08-29 18:38:11 +0000927 if (arg == Py_None)
928 *p = 0;
929 else if (PyUnicode_Check(arg))
930 *p = PyUnicode_AS_UNICODE(arg);
931 else
Guido van Rossum98297ee2007-11-06 21:34:58 +0000932 return converterr("string or None",
Guido van Rossumfb67be22007-08-29 18:38:11 +0000933 arg, msgbuf, bufsize);
934 }
935 break;
936 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000937
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000938 case 'e': {/* encoded string */
939 char **buffer;
940 const char *encoding;
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000941 PyObject *s;
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000942 int recode_strings;
943 Py_ssize_t size;
Guido van Rossumd70539a2007-05-09 23:35:09 +0000944 const char *ptr;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000945
946 /* Get 'e' parameter: the encoding name */
947 encoding = (const char *)va_arg(*p_va, const char *);
948 if (encoding == NULL)
949 encoding = PyUnicode_GetDefaultEncoding();
Guido van Rossum98297ee2007-11-06 21:34:58 +0000950
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000951 /* Get output buffer parameter:
952 's' (recode all objects via Unicode) or
Guido van Rossum98297ee2007-11-06 21:34:58 +0000953 't' (only recode non-string objects)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000954 */
955 if (*format == 's')
956 recode_strings = 1;
957 else if (*format == 't')
958 recode_strings = 0;
959 else
960 return converterr(
961 "(unknown parser marker combination)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000962 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000963 buffer = (char **)va_arg(*p_va, char **);
964 format++;
965 if (buffer == NULL)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000966 return converterr("(buffer is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000967 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000968
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000969 /* Encode object */
Guido van Rossumd70539a2007-05-09 23:35:09 +0000970 if (!recode_strings &&
971 (PyString_Check(arg) || PyBytes_Check(arg))) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000972 s = arg;
973 Py_INCREF(s);
Guido van Rossumd70539a2007-05-09 23:35:09 +0000974 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
975 return converterr("(AsCharBuffer failed)",
976 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000977 }
978 else {
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000979 PyObject *u;
980
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000981 /* Convert object to Unicode */
982 u = PyUnicode_FromObject(arg);
983 if (u == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000984 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +0000985 "string or unicode or text buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000986 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000987
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000988 /* Encode object; use default error handling */
989 s = PyUnicode_AsEncodedString(u,
990 encoding,
991 NULL);
992 Py_DECREF(u);
993 if (s == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000994 return converterr("(encoding failed)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000995 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000996 if (!PyString_Check(s)) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000997 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000998 return converterr(
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000999 "(encoder failed to return bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001000 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001001 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001002 size = PyString_GET_SIZE(s);
1003 ptr = PyString_AS_STRING(s);
Guido van Rossumd70539a2007-05-09 23:35:09 +00001004 if (ptr == NULL)
1005 ptr = "";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001006 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001007
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001008 /* Write output; output is guaranteed to be 0-terminated */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001009 if (*format == '#') {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001010 /* Using buffer length parameter '#':
Guido van Rossum98297ee2007-11-06 21:34:58 +00001011
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001012 - if *buffer is NULL, a new buffer of the
1013 needed size is allocated and the data
1014 copied into it; *buffer is updated to point
1015 to the new buffer; the caller is
1016 responsible for PyMem_Free()ing it after
Guido van Rossum98297ee2007-11-06 21:34:58 +00001017 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001018
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001019 - if *buffer is not NULL, the data is
1020 copied to *buffer; *buffer_len has to be
1021 set to the size of the buffer on input;
1022 buffer overflow is signalled with an error;
1023 buffer has to provide enough room for the
1024 encoded string plus the trailing 0-byte
Guido van Rossum98297ee2007-11-06 21:34:58 +00001025
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001026 - in both cases, *buffer_len is updated to
1027 the size of the buffer /excluding/ the
Guido van Rossum98297ee2007-11-06 21:34:58 +00001028 trailing 0-byte
1029
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001030 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001031 FETCH_SIZE;
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001032
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001033 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001034 if (q == NULL && q2 == NULL) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001035 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001036 return converterr(
1037 "(buffer_len is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001038 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001039 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001040 if (*buffer == NULL) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001041 *buffer = PyMem_NEW(char, size + 1);
1042 if (*buffer == NULL) {
1043 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001044 return converterr(
1045 "(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001046 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001047 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001048 if(addcleanup(*buffer, freelist)) {
1049 Py_DECREF(s);
1050 return converterr(
1051 "(cleanup problem)",
1052 arg, msgbuf, bufsize);
1053 }
Fred Drake25871c02000-05-03 15:17:02 +00001054 } else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001055 if (size + 1 > BUFFER_LEN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001056 Py_DECREF(s);
1057 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001058 "(buffer overflow)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001059 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001060 }
Fred Drake25871c02000-05-03 15:17:02 +00001061 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001062 memcpy(*buffer, ptr, size+1);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001063 STORE_SIZE(size);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001064 } else {
1065 /* Using a 0-terminated buffer:
Guido van Rossum98297ee2007-11-06 21:34:58 +00001066
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001067 - the encoded string has to be 0-terminated
1068 for this variant to work; if it is not, an
Guido van Rossum98297ee2007-11-06 21:34:58 +00001069 error raised
Fred Drake25871c02000-05-03 15:17:02 +00001070
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001071 - a new buffer of the needed size is
1072 allocated and the data copied into it;
1073 *buffer is updated to point to the new
1074 buffer; the caller is responsible for
1075 PyMem_Free()ing it after usage
1076
1077 */
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001078 if ((Py_ssize_t)strlen(ptr) != size) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001079 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001080 return converterr(
1081 "(encoded string without NULL bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001082 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001083 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001084 *buffer = PyMem_NEW(char, size + 1);
1085 if (*buffer == NULL) {
1086 Py_DECREF(s);
1087 return converterr("(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001088 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001089 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001090 if(addcleanup(*buffer, freelist)) {
1091 Py_DECREF(s);
1092 return converterr("(cleanup problem)",
1093 arg, msgbuf, bufsize);
1094 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001095 memcpy(*buffer, ptr, size+1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001096 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001097 Py_DECREF(s);
1098 break;
1099 }
1100
1101 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001102 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1103 if (!PyUnicode_Check(arg))
1104 return converterr("str", arg, msgbuf, bufsize);
1105 *p = PyUnicode_AS_UNICODE(arg);
1106 if (*format == '#') { /* store pointer and size */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001107 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001108 STORE_SIZE(PyUnicode_GET_SIZE(arg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001109 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001110 }
1111 break;
1112 }
1113
Guido van Rossum98297ee2007-11-06 21:34:58 +00001114 case 'S': { /* PyString object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001115 PyObject **p = va_arg(*p_va, PyObject **);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001116 if (PyString_Check(arg))
Guido van Rossum617dbc42007-05-07 23:57:08 +00001117 *p = arg;
1118 else
1119 return converterr("bytes", arg, msgbuf, bufsize);
1120 break;
1121 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001122
1123 case 'Y': { /* PyBytes object */
1124 PyObject **p = va_arg(*p_va, PyObject **);
1125 if (PyBytes_Check(arg))
1126 *p = arg;
1127 else
1128 return converterr("buffer", arg, msgbuf, bufsize);
1129 break;
1130 }
1131
1132 case 'U': { /* PyUnicode object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001133 PyObject **p = va_arg(*p_va, PyObject **);
1134 if (PyUnicode_Check(arg))
1135 *p = arg;
1136 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001137 return converterr("str", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001138 break;
1139 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001140
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001141 case 'O': { /* object */
1142 PyTypeObject *type;
1143 PyObject **p;
1144 if (*format == '!') {
1145 type = va_arg(*p_va, PyTypeObject*);
1146 p = va_arg(*p_va, PyObject **);
1147 format++;
Guido van Rossumcbfc8552001-08-28 16:37:51 +00001148 if (PyType_IsSubtype(arg->ob_type, type))
Guido van Rossume826ef02000-03-10 23:02:17 +00001149 *p = arg;
1150 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001151 return converterr(type->tp_name, arg, msgbuf, bufsize);
Guido van Rossumfccfe891998-05-15 22:04:07 +00001152
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001153 }
1154 else if (*format == '?') {
1155 inquiry pred = va_arg(*p_va, inquiry);
1156 p = va_arg(*p_va, PyObject **);
1157 format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001158 if ((*pred)(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001159 *p = arg;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001160 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001161 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001162 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001163
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001164 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001165 else if (*format == '&') {
1166 typedef int (*converter)(PyObject *, void *);
1167 converter convert = va_arg(*p_va, converter);
1168 void *addr = va_arg(*p_va, void *);
1169 format++;
1170 if (! (*convert)(arg, addr))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001171 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001172 arg, msgbuf, bufsize);
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001173 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001174 else {
1175 p = va_arg(*p_va, PyObject **);
1176 *p = arg;
1177 }
1178 break;
1179 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001180
1181
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001182 case 'w': { /* memory buffer, read-write access */
1183 void **p = va_arg(*p_va, void **);
1184 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1185 int count;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001186 int temp=-1;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001187 Py_buffer view;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001188
1189 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001190 pb->bf_getbuffer == NULL ||
Guido van Rossum98297ee2007-11-06 21:34:58 +00001191 ((temp = (*pb->bf_getbuffer)(arg, &view,
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001192 PyBUF_SIMPLE)) != 0) ||
1193 view.readonly == 1) {
1194 if (temp==0 && pb->bf_releasebuffer != NULL) {
1195 (*pb->bf_releasebuffer)(arg, &view);
1196 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001197 return converterr("single-segment read-write buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001198 arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001199 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001200
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001201 if ((count = view.len) < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001202 return converterr("(unspecified)", arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001203 *p = view.buf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001204 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001205 FETCH_SIZE;
1206 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001207 format++;
1208 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001209 if (pb->bf_releasebuffer != NULL)
1210 (*pb->bf_releasebuffer)(arg, &view);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001211 break;
1212 }
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001213
1214 /*TEO: This can be eliminated --- here only for backward
1215 compatibility */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001216 case 't': { /* 8-bit character buffer, read-only access */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001217 char **p = va_arg(*p_va, char **);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001218 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001219 int count;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001220 Py_buffer view;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001221
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001222 if (*format++ != '#')
1223 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001224 "invalid use of 't' format character",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001225 arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001226 if (pb == NULL || pb->bf_getbuffer == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001227 return converterr(
Alexandre Vassalotti70a23712007-10-14 02:05:51 +00001228 "bytes or read-only character buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001229 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001230
Guido van Rossum98297ee2007-11-06 21:34:58 +00001231 if ((*pb->bf_getbuffer)(arg, &view, PyBUF_SIMPLE) != 0)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001232 return converterr("string or single-segment read-only buffer",
1233 arg, msgbuf, bufsize);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001234
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001235 count = view.len;
1236 *p = view.buf;
1237 /* XXX : shouldn't really release buffer, but it should be O.K.
1238 */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001239 if (pb->bf_releasebuffer != NULL)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001240 (*pb->bf_releasebuffer)(arg, &view);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001241 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001242 return converterr("(unspecified)", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001243 {
1244 FETCH_SIZE;
1245 STORE_SIZE(count);
1246 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001247 break;
1248 }
1249
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001250 default:
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001251 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001252
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001253 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001254
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001255 *p_format = format;
1256 return NULL;
1257}
Guido van Rossumaa354651996-08-19 19:32:04 +00001258
Martin v. Löwis18e16552006-02-15 17:27:45 +00001259static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001260convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001261{
1262 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001263 Py_ssize_t count;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001264 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001265
1266 *errmsg = NULL;
1267 *p = NULL;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001268 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001269 pb->bf_getbuffer == NULL) {
Guido van Rossumb0834002007-11-21 21:53:51 +00001270 *errmsg = "bytes or read-only buffer";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001271 return -1;
1272 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001273
1274 if ((*pb->bf_getbuffer)(arg, &view, PyBUF_SIMPLE) != 0) {
Guido van Rossumb0834002007-11-21 21:53:51 +00001275 *errmsg = "bytes or single-segment read-only buffer";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001276 return -1;
1277 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001278 count = view.len;
1279 *p = view.buf;
1280 if (pb->bf_releasebuffer != NULL)
1281 (*pb->bf_releasebuffer)(arg, &view);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001282 return count;
1283}
Guido van Rossumaa354651996-08-19 19:32:04 +00001284
1285/* Support for keyword arguments donated by
1286 Geoff Philbrick <philbric@delphi.hks.com> */
1287
Tim Petersf8cd3e82001-10-27 04:26:57 +00001288/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001289int
1290PyArg_ParseTupleAndKeywords(PyObject *args,
1291 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001292 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001293 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001294{
1295 int retval;
1296 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001297
1298 if ((args == NULL || !PyTuple_Check(args)) ||
1299 (keywords != NULL && !PyDict_Check(keywords)) ||
1300 format == NULL ||
1301 kwlist == NULL)
1302 {
1303 PyErr_BadInternalCall();
Tim Petersf8cd3e82001-10-27 04:26:57 +00001304 return 0;
Tim Peters45772cd2001-10-27 03:58:40 +00001305 }
1306
Guido van Rossumaa354651996-08-19 19:32:04 +00001307 va_start(va, kwlist);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001308 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001309 va_end(va);
1310 return retval;
1311}
1312
1313int
1314_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1315 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001316 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001317 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001318{
1319 int retval;
1320 va_list va;
1321
1322 if ((args == NULL || !PyTuple_Check(args)) ||
1323 (keywords != NULL && !PyDict_Check(keywords)) ||
1324 format == NULL ||
1325 kwlist == NULL)
1326 {
1327 PyErr_BadInternalCall();
1328 return 0;
1329 }
1330
1331 va_start(va, kwlist);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001332 retval = vgetargskeywords(args, keywords, format,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001333 kwlist, &va, FLAG_SIZE_T);
Guido van Rossumaa354651996-08-19 19:32:04 +00001334 va_end(va);
1335 return retval;
1336}
1337
1338
Brett Cannon711e7d92004-07-10 22:20:32 +00001339int
1340PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001341 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001342 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001343 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001344{
1345 int retval;
1346 va_list lva;
1347
1348 if ((args == NULL || !PyTuple_Check(args)) ||
1349 (keywords != NULL && !PyDict_Check(keywords)) ||
1350 format == NULL ||
1351 kwlist == NULL)
1352 {
1353 PyErr_BadInternalCall();
1354 return 0;
1355 }
1356
1357#ifdef VA_LIST_IS_ARRAY
1358 memcpy(lva, va, sizeof(va_list));
1359#else
1360#ifdef __va_copy
1361 __va_copy(lva, va);
1362#else
1363 lva = va;
1364#endif
1365#endif
1366
Guido van Rossum98297ee2007-11-06 21:34:58 +00001367 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001368 return retval;
1369}
1370
1371int
1372_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1373 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001374 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001375 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001376{
1377 int retval;
1378 va_list lva;
1379
1380 if ((args == NULL || !PyTuple_Check(args)) ||
1381 (keywords != NULL && !PyDict_Check(keywords)) ||
1382 format == NULL ||
1383 kwlist == NULL)
1384 {
1385 PyErr_BadInternalCall();
1386 return 0;
1387 }
1388
1389#ifdef VA_LIST_IS_ARRAY
1390 memcpy(lva, va, sizeof(va_list));
1391#else
1392#ifdef __va_copy
1393 __va_copy(lva, va);
1394#else
1395 lva = va;
1396#endif
1397#endif
1398
Guido van Rossum98297ee2007-11-06 21:34:58 +00001399 retval = vgetargskeywords(args, keywords, format,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001400 kwlist, &lva, FLAG_SIZE_T);
Brett Cannon711e7d92004-07-10 22:20:32 +00001401 return retval;
1402}
1403
1404
Guido van Rossumaa354651996-08-19 19:32:04 +00001405static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001406vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001407 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001408{
Tim Petersdc5eff92001-10-27 06:53:00 +00001409 char msgbuf[512];
Guido van Rossumaa354651996-08-19 19:32:04 +00001410 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001411 const char *fname, *message;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001412 int min, max;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001413 const char *formatsave;
Tim Petersb639d492001-10-27 07:00:56 +00001414 int i, len, nargs, nkeywords;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001415 const char *msg;
1416 char **p;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001417 PyObject *freelist = NULL;
Tim Petersf4331c12001-10-27 00:17:34 +00001418
Tim Peters45772cd2001-10-27 03:58:40 +00001419 assert(args != NULL && PyTuple_Check(args));
1420 assert(keywords == NULL || PyDict_Check(keywords));
1421 assert(format != NULL);
1422 assert(kwlist != NULL);
1423 assert(p_va != NULL);
1424
Tim Petersf8cd3e82001-10-27 04:26:57 +00001425 /* Search the format:
1426 message <- error msg, if any (else NULL).
Tim Peterscffed4b2001-11-29 03:26:37 +00001427 fname <- routine name, if any (else NULL).
Tim Petersf8cd3e82001-10-27 04:26:57 +00001428 min <- # of required arguments, or -1 if all are required.
1429 max <- most arguments (required + optional).
Tim Peters62d48e12001-10-27 06:42:16 +00001430 Check that kwlist has a non-NULL entry for each arg.
Tim Petersf8cd3e82001-10-27 04:26:57 +00001431 Raise error if a tuple arg spec is found.
1432 */
1433 fname = message = NULL;
Tim Peters6fb26352001-10-27 04:38:11 +00001434 formatsave = format;
Tim Peters62d48e12001-10-27 06:42:16 +00001435 p = kwlist;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001436 min = -1;
1437 max = 0;
1438 while ((i = *format++) != '\0') {
Neal Norwitz30b5c5d2005-12-19 06:05:18 +00001439 if (isalpha(Py_CHARMASK(i)) && i != 'e') {
Tim Petersf8cd3e82001-10-27 04:26:57 +00001440 max++;
Tim Peters62d48e12001-10-27 06:42:16 +00001441 if (*p == NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001442 PyErr_SetString(PyExc_RuntimeError,
1443 "more argument specifiers than "
1444 "keyword list entries");
Tim Peters62d48e12001-10-27 06:42:16 +00001445 return 0;
1446 }
1447 p++;
1448 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001449 else if (i == '|')
1450 min = max;
1451 else if (i == ':') {
1452 fname = format;
1453 break;
1454 }
1455 else if (i == ';') {
1456 message = format;
1457 break;
1458 }
1459 else if (i == '(') {
Tim Peterscffed4b2001-11-29 03:26:37 +00001460 PyErr_SetString(PyExc_RuntimeError,
1461 "tuple found in format when using keyword "
1462 "arguments");
Guido van Rossumaa354651996-08-19 19:32:04 +00001463 return 0;
1464 }
Tim Peters62d48e12001-10-27 06:42:16 +00001465 }
1466 format = formatsave;
1467 if (*p != NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001468 PyErr_SetString(PyExc_RuntimeError,
1469 "more keyword list entries than "
1470 "argument specifiers");
Tim Peters62d48e12001-10-27 06:42:16 +00001471 return 0;
1472 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001473 if (min < 0) {
1474 /* All arguments are required. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001475 min = max;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001476 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001477
Tim Peters6fb26352001-10-27 04:38:11 +00001478 nargs = PyTuple_GET_SIZE(args);
Tim Petersb0872fc2001-10-27 04:45:34 +00001479 nkeywords = keywords == NULL ? 0 : PyDict_Size(keywords);
Tim Petersf8cd3e82001-10-27 04:26:57 +00001480
Guido van Rossumaa354651996-08-19 19:32:04 +00001481 /* make sure there are no duplicate values for an argument;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001482 its not clear when to use the term "keyword argument vs.
Guido van Rossumaa354651996-08-19 19:32:04 +00001483 keyword parameter in messages */
Tim Petersb054be42001-10-27 05:07:41 +00001484 if (nkeywords > 0) {
Tim Peters6fb26352001-10-27 04:38:11 +00001485 for (i = 0; i < nargs; i++) {
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001486 const char *thiskw = kwlist[i];
Tim Petersa9f47392001-10-27 00:46:09 +00001487 if (thiskw == NULL)
1488 break;
Tim Peters077f5742001-10-27 05:50:39 +00001489 if (PyDict_GetItemString(keywords, thiskw)) {
Tim Petersb054be42001-10-27 05:07:41 +00001490 PyErr_Format(PyExc_TypeError,
1491 "keyword parameter '%s' was given "
1492 "by position and by name",
Tim Petersa9f47392001-10-27 00:46:09 +00001493 thiskw);
Guido van Rossumaa354651996-08-19 19:32:04 +00001494 return 0;
1495 }
Tim Peters0af49162001-10-27 06:14:32 +00001496 else if (PyErr_Occurred())
1497 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001498 }
1499 }
Tim Peters61dde632001-10-27 05:30:17 +00001500
Guido van Rossum98297ee2007-11-06 21:34:58 +00001501 /* required arguments missing from args can be supplied by keyword
Georg Brandld7048172006-01-20 17:53:27 +00001502 arguments; set len to the number of positional arguments, and,
Tim Peters62d48e12001-10-27 06:42:16 +00001503 if that's less than the minimum required, add in the number of
1504 required arguments that are supplied by keywords */
Tim Peters6fb26352001-10-27 04:38:11 +00001505 len = nargs;
Tim Peters62d48e12001-10-27 06:42:16 +00001506 if (nkeywords > 0 && nargs < min) {
Tim Peters6fb26352001-10-27 04:38:11 +00001507 for (i = nargs; i < min; i++) {
Tim Peters077f5742001-10-27 05:50:39 +00001508 if (PyDict_GetItemString(keywords, kwlist[i]))
Guido van Rossumaa354651996-08-19 19:32:04 +00001509 len++;
Tim Peters0af49162001-10-27 06:14:32 +00001510 else if (PyErr_Occurred())
1511 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001512 }
1513 }
Tim Peters0af49162001-10-27 06:14:32 +00001514
Guido van Rossumaa354651996-08-19 19:32:04 +00001515 /* make sure we got an acceptable number of arguments; the message
1516 is a little confusing with keywords since keyword arguments
1517 which are supplied, but don't match the required arguments
Guido van Rossum98297ee2007-11-06 21:34:58 +00001518 are not included in the "%d given" part of the message
Michael W. Hudson5253c302005-03-30 16:41:55 +00001519 XXX and this isn't a bug!? */
Guido van Rossumaa354651996-08-19 19:32:04 +00001520 if (len < min || max < len) {
1521 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +00001522 PyOS_snprintf(msgbuf, sizeof(msgbuf),
1523 "%.200s%s takes %s %d argument%s "
1524 "(%d given)",
1525 fname==NULL ? "function" : fname,
1526 fname==NULL ? "" : "()",
1527 min==max ? "exactly"
1528 : len < min ? "at least" : "at most",
1529 len < min ? min : max,
1530 (len < min ? min : max) == 1 ? "" : "s",
1531 len);
Guido van Rossumaa354651996-08-19 19:32:04 +00001532 message = msgbuf;
1533 }
1534 PyErr_SetString(PyExc_TypeError, message);
1535 return 0;
1536 }
Tim Petersc2f01122001-10-27 07:25:06 +00001537
1538 /* convert the positional arguments */
Tim Peters6fb26352001-10-27 04:38:11 +00001539 for (i = 0; i < nargs; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001540 if (*format == '|')
1541 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +00001542 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001543 flags, levels, msgbuf, sizeof(msgbuf),
Martin v. Löwis18e16552006-02-15 17:27:45 +00001544 &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001545 if (msg) {
1546 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001547 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001548 }
1549 }
1550
Guido van Rossum98297ee2007-11-06 21:34:58 +00001551 /* handle no keyword parameters in call */
Tim Petersb054be42001-10-27 05:07:41 +00001552 if (nkeywords == 0)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001553 return cleanreturn(1, freelist);
Tim Petersb054be42001-10-27 05:07:41 +00001554
Guido van Rossum98297ee2007-11-06 21:34:58 +00001555 /* convert the keyword arguments; this uses the format
Guido van Rossumaa354651996-08-19 19:32:04 +00001556 string where it was left after processing args */
Tim Petersb639d492001-10-27 07:00:56 +00001557 for (i = nargs; i < max; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001558 PyObject *item;
Guido van Rossumaa354651996-08-19 19:32:04 +00001559 if (*format == '|')
1560 format++;
Tim Peters077f5742001-10-27 05:50:39 +00001561 item = PyDict_GetItemString(keywords, kwlist[i]);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001562 if (item != NULL) {
Tim Peters077f5742001-10-27 05:50:39 +00001563 Py_INCREF(item);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001564 msg = convertitem(item, &format, p_va, flags, levels,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001565 msgbuf, sizeof(msgbuf), &freelist);
Tim Peters077f5742001-10-27 05:50:39 +00001566 Py_DECREF(item);
Guido van Rossumaa354651996-08-19 19:32:04 +00001567 if (msg) {
1568 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001569 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001570 }
Tim Petersc2f01122001-10-27 07:25:06 +00001571 --nkeywords;
1572 if (nkeywords == 0)
1573 break;
Guido van Rossumaa354651996-08-19 19:32:04 +00001574 }
Tim Peters0af49162001-10-27 06:14:32 +00001575 else if (PyErr_Occurred())
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001576 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001577 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001578 msg = skipitem(&format, p_va, flags);
Guido van Rossumaa354651996-08-19 19:32:04 +00001579 if (msg) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001580 levels[0] = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001581 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001582 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001583 }
1584 }
1585 }
Tim Petersb054be42001-10-27 05:07:41 +00001586
Guido van Rossumaa354651996-08-19 19:32:04 +00001587 /* make sure there are no extraneous keyword arguments */
Tim Petersc2f01122001-10-27 07:25:06 +00001588 if (nkeywords > 0) {
1589 PyObject *key, *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001590 Py_ssize_t pos = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001591 while (PyDict_Next(keywords, &pos, &key, &value)) {
Tim Petersc2f01122001-10-27 07:25:06 +00001592 int match = 0;
Guido van Rossum55474762002-04-04 16:22:30 +00001593 char *ks;
Guido van Rossum572dbf82007-04-27 23:53:51 +00001594 if (!PyString_Check(key) && !PyUnicode_Check(key)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00001595 PyErr_SetString(PyExc_TypeError,
Guido van Rossum55474762002-04-04 16:22:30 +00001596 "keywords must be strings");
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001597 return cleanreturn(0, freelist);
Guido van Rossum55474762002-04-04 16:22:30 +00001598 }
Amaury Forgeot d'Arc39599dc2007-11-22 02:48:12 +00001599 ks = PyUnicode_AsString(key);
Tim Petersb639d492001-10-27 07:00:56 +00001600 for (i = 0; i < max; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001601 if (!strcmp(ks, kwlist[i])) {
1602 match = 1;
1603 break;
1604 }
1605 }
1606 if (!match) {
Tim Petersc2f01122001-10-27 07:25:06 +00001607 PyErr_Format(PyExc_TypeError,
1608 "'%s' is an invalid keyword "
1609 "argument for this function",
1610 ks);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001611 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001612 }
1613 }
1614 }
Tim Petersc2f01122001-10-27 07:25:06 +00001615
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001616 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001617}
1618
1619
1620static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001621skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001622{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001623 const char *format = *p_format;
Guido van Rossumaa354651996-08-19 19:32:04 +00001624 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001625
Guido van Rossumaa354651996-08-19 19:32:04 +00001626 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001627
1628 /* simple codes
1629 * The individual types (second arg of va_arg) are irrelevant */
1630
Guido van Rossumaa354651996-08-19 19:32:04 +00001631 case 'b': /* byte -- very short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001632 case 'B': /* byte as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001633 case 'h': /* short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001634 case 'H': /* short int as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001635 case 'i': /* int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001636 case 'I': /* int sized bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001637 case 'l': /* long int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001638 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001639#ifdef HAVE_LONG_LONG
Georg Brandl6dd14612005-09-14 19:29:53 +00001640 case 'L': /* PY_LONG_LONG */
1641 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001642#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001643 case 'f': /* float */
Guido van Rossumaa354651996-08-19 19:32:04 +00001644 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001645#ifndef WITHOUT_COMPLEX
1646 case 'D': /* complex double */
Georg Brandl6dd14612005-09-14 19:29:53 +00001647#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001648 case 'c': /* char */
1649 {
Georg Brandl6dd14612005-09-14 19:29:53 +00001650 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001651 break;
1652 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001653
1654 case 'n': /* Py_ssize_t */
1655 {
1656 (void) va_arg(*p_va, Py_ssize_t *);
1657 break;
1658 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001659
Georg Brandl6dd14612005-09-14 19:29:53 +00001660 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001661
Georg Brandl6dd14612005-09-14 19:29:53 +00001662 case 'e': /* string with encoding */
1663 {
1664 (void) va_arg(*p_va, const char *);
1665 if (!(*format == 's' || *format == 't'))
1666 /* after 'e', only 's' and 't' is allowed */
1667 goto err;
1668 format++;
1669 /* explicit fallthrough to string cases */
1670 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001671
Guido van Rossumaa354651996-08-19 19:32:04 +00001672 case 's': /* string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001673 case 'z': /* string or None */
Walter Dörwald612344f2007-05-04 19:28:21 +00001674 case 'y': /* bytes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001675 case 'u': /* unicode string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001676 case 't': /* buffer, read-only */
1677 case 'w': /* buffer, read-write */
Guido van Rossumaa354651996-08-19 19:32:04 +00001678 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001679 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001680 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001681 if (flags & FLAG_SIZE_T)
1682 (void) va_arg(*p_va, Py_ssize_t *);
1683 else
1684 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001685 format++;
1686 }
1687 break;
1688 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001689
1690 /* object codes */
1691
Guido van Rossumaa354651996-08-19 19:32:04 +00001692 case 'S': /* string object */
Guido van Rossum617dbc42007-05-07 23:57:08 +00001693 case 'Y': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001694 case 'U': /* unicode string object */
Guido van Rossumaa354651996-08-19 19:32:04 +00001695 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001696 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001697 break;
1698 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001699
Guido van Rossumaa354651996-08-19 19:32:04 +00001700 case 'O': /* object */
1701 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001702 if (*format == '!') {
1703 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001704 (void) va_arg(*p_va, PyTypeObject*);
1705 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001706 }
1707#if 0
1708/* I don't know what this is for */
1709 else if (*format == '?') {
1710 inquiry pred = va_arg(*p_va, inquiry);
1711 format++;
1712 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001713 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001714 }
1715 }
1716#endif
1717 else if (*format == '&') {
Tim Petersdbd9ba62000-07-09 03:09:57 +00001718 typedef int (*converter)(PyObject *, void *);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001719 (void) va_arg(*p_va, converter);
1720 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001721 format++;
1722 }
1723 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001724 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001725 }
1726 break;
1727 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001728
Guido van Rossumaa354651996-08-19 19:32:04 +00001729 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001730err:
Guido van Rossumaa354651996-08-19 19:32:04 +00001731 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001732
Guido van Rossumaa354651996-08-19 19:32:04 +00001733 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001734
1735 /* The "(...)" format code for tuples is not handled here because
1736 * it is not allowed with keyword args. */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001737
Guido van Rossumaa354651996-08-19 19:32:04 +00001738 *p_format = format;
1739 return NULL;
1740}
Fred Drakee4616e62001-10-23 21:09:29 +00001741
1742
1743int
Martin v. Löwis76246742006-03-01 04:06:10 +00001744PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001745{
Martin v. Löwis76246742006-03-01 04:06:10 +00001746 Py_ssize_t i, l;
Fred Drakee4616e62001-10-23 21:09:29 +00001747 PyObject **o;
1748 va_list vargs;
1749
1750#ifdef HAVE_STDARG_PROTOTYPES
1751 va_start(vargs, max);
1752#else
1753 va_start(vargs);
1754#endif
1755
1756 assert(min >= 0);
1757 assert(min <= max);
1758 if (!PyTuple_Check(args)) {
1759 PyErr_SetString(PyExc_SystemError,
1760 "PyArg_UnpackTuple() argument list is not a tuple");
1761 return 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001762 }
Fred Drakee4616e62001-10-23 21:09:29 +00001763 l = PyTuple_GET_SIZE(args);
1764 if (l < min) {
1765 if (name != NULL)
1766 PyErr_Format(
1767 PyExc_TypeError,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001768 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001769 name, (min == max ? "" : "at least "), min, l);
1770 else
1771 PyErr_Format(
1772 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001773 "unpacked tuple should have %s%zd elements,"
Guido van Rossum98297ee2007-11-06 21:34:58 +00001774 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001775 (min == max ? "" : "at least "), min, l);
1776 va_end(vargs);
1777 return 0;
1778 }
1779 if (l > max) {
1780 if (name != NULL)
1781 PyErr_Format(
1782 PyExc_TypeError,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001783 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001784 name, (min == max ? "" : "at most "), max, l);
1785 else
1786 PyErr_Format(
1787 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001788 "unpacked tuple should have %s%zd elements,"
Guido van Rossum98297ee2007-11-06 21:34:58 +00001789 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001790 (min == max ? "" : "at most "), max, l);
1791 va_end(vargs);
1792 return 0;
1793 }
1794 for (i = 0; i < l; i++) {
1795 o = va_arg(vargs, PyObject **);
1796 *o = PyTuple_GET_ITEM(args, i);
1797 }
1798 va_end(vargs);
1799 return 1;
1800}
Georg Brandl02c42872005-08-26 06:42:30 +00001801
1802
1803/* For type constructors that don't take keyword args
1804 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001805 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001806 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001807 */
1808int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001809_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001810{
1811 if (kw == NULL)
1812 return 1;
1813 if (!PyDict_CheckExact(kw)) {
1814 PyErr_BadInternalCall();
1815 return 0;
1816 }
1817 if (PyDict_Size(kw) == 0)
1818 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001819
1820 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
Georg Brandl02c42872005-08-26 06:42:30 +00001821 funcname);
1822 return 0;
1823}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001824#ifdef __cplusplus
1825};
1826#endif