blob: 15f6dd218106a1268ac30b2db48b8887ba580f27 [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 **);
Martin v. Löwis423be952008-08-13 15:53:07 +000047static int getbuffer(PyObject *, Py_buffer *, char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000048
Tim Petersdbd9ba62000-07-09 03:09:57 +000049static int vgetargskeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000050 const char *, char **, va_list *, int);
Martin v. Löwis18e16552006-02-15 17:27:45 +000051static char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000052
Fred Drake563dfc22001-10-23 14:41:08 +000053int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000054PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000055{
56 int retval;
57 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000058
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000059 va_start(va, format);
Martin v. Löwis18e16552006-02-15 17:27:45 +000060 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
61 va_end(va);
62 return retval;
63}
64
65int
66_PyArg_Parse_SizeT(PyObject *args, char *format, ...)
67{
68 int retval;
69 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000070
Martin v. Löwis18e16552006-02-15 17:27:45 +000071 va_start(va, format);
72 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000073 va_end(va);
74 return retval;
75}
76
77
Fred Drake563dfc22001-10-23 14:41:08 +000078int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000079PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000080{
81 int retval;
82 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000083
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000084 va_start(va, format);
Guido van Rossum1ae940a1995-01-02 19:04:15 +000085 retval = vgetargs1(args, format, &va, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000086 va_end(va);
87 return retval;
88}
89
Martin v. Löwis18e16552006-02-15 17:27:45 +000090int
91_PyArg_ParseTuple_SizeT(PyObject *args, char *format, ...)
92{
93 int retval;
94 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000095
Martin v. Löwis18e16552006-02-15 17:27:45 +000096 va_start(va, format);
97 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
98 va_end(va);
99 return retval;
100}
101
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000102
103int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000104PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000105{
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000106 va_list lva;
107
108#ifdef VA_LIST_IS_ARRAY
109 memcpy(lva, va, sizeof(va_list));
110#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000111#ifdef __va_copy
112 __va_copy(lva, va);
113#else
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000114 lva = va;
115#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000116#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000117
118 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000119}
120
Martin v. Löwis18e16552006-02-15 17:27:45 +0000121int
122_PyArg_VaParse_SizeT(PyObject *args, char *format, va_list va)
123{
124 va_list lva;
125
126#ifdef VA_LIST_IS_ARRAY
127 memcpy(lva, va, sizeof(va_list));
128#else
129#ifdef __va_copy
130 __va_copy(lva, va);
131#else
132 lva = va;
133#endif
134#endif
135
136 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
137}
138
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000139
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000140/* Handle cleanup of allocated memory in case of exception */
141
Benjamin Petersonb173f782009-05-05 22:31:58 +0000142#define GETARGS_CAPSULE_NAME_CLEANUP_PTR "getargs.cleanup_ptr"
143#define GETARGS_CAPSULE_NAME_CLEANUP_BUFFER "getargs.cleanup_buffer"
144
Antoine Pitrouf71995782008-08-29 18:37:05 +0000145static void
Benjamin Petersonb173f782009-05-05 22:31:58 +0000146cleanup_ptr(PyObject *self)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000147{
Benjamin Petersonb173f782009-05-05 22:31:58 +0000148 void *ptr = PyCapsule_GetPointer(self, GETARGS_CAPSULE_NAME_CLEANUP_PTR);
149 if (ptr) {
150 PyMem_FREE(ptr);
151 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000152}
153
154static void
Benjamin Petersonb173f782009-05-05 22:31:58 +0000155cleanup_buffer(PyObject *self)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000156{
Benjamin Petersonb173f782009-05-05 22:31:58 +0000157 Py_buffer *ptr = (Py_buffer *)PyCapsule_GetPointer(self, GETARGS_CAPSULE_NAME_CLEANUP_BUFFER);
158 if (ptr) {
159 PyBuffer_Release(ptr);
160 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000161}
162
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000163static int
Benjamin Petersonb173f782009-05-05 22:31:58 +0000164addcleanup(void *ptr, PyObject **freelist, PyCapsule_Destructor destr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000165{
166 PyObject *cobj;
Benjamin Petersonb173f782009-05-05 22:31:58 +0000167 const char *name;
168
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000169 if (!*freelist) {
170 *freelist = PyList_New(0);
171 if (!*freelist) {
Antoine Pitrouf71995782008-08-29 18:37:05 +0000172 destr(ptr);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000173 return -1;
174 }
175 }
Benjamin Petersonb173f782009-05-05 22:31:58 +0000176
177 if (destr == cleanup_ptr) {
178 name = GETARGS_CAPSULE_NAME_CLEANUP_PTR;
179 } else if (destr == cleanup_buffer) {
180 name = GETARGS_CAPSULE_NAME_CLEANUP_BUFFER;
181 } else {
182 return -1;
183 }
184 cobj = PyCapsule_New(ptr, name, destr);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000185 if (!cobj) {
Antoine Pitrouf71995782008-08-29 18:37:05 +0000186 destr(ptr);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000187 return -1;
188 }
Christian Heimes836baa52008-02-26 08:18:30 +0000189 if (PyList_Append(*freelist, cobj)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000190 Py_DECREF(cobj);
191 return -1;
192 }
193 Py_DECREF(cobj);
194 return 0;
195}
196
197static int
198cleanreturn(int retval, PyObject *freelist)
199{
Antoine Pitrouf71995782008-08-29 18:37:05 +0000200 if (freelist && retval != 0) {
201 /* We were successful, reset the destructors so that they
202 don't get called. */
203 Py_ssize_t len = PyList_GET_SIZE(freelist), i;
204 for (i = 0; i < len; i++)
Benjamin Petersonb173f782009-05-05 22:31:58 +0000205 PyCapsule_SetDestructor(PyList_GET_ITEM(freelist, i), NULL);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000206 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000207 Py_XDECREF(freelist);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000208 return retval;
209}
210
211
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000212static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000213vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000214{
215 char msgbuf[256];
216 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000217 const char *fname = NULL;
218 const char *message = NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000219 int min = -1;
220 int max = 0;
221 int level = 0;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000222 int endfmt = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000223 const char *formatsave = format;
Martin v. Löwisd96ee902006-02-16 14:37:16 +0000224 Py_ssize_t i, len;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000225 char *msg;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000226 PyObject *freelist = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000227 int compat = flags & FLAG_COMPAT;
228
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000229 assert(compat || (args != (PyObject*)NULL));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000230 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000231
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000232 while (endfmt == 0) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000233 int c = *format++;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000234 switch (c) {
235 case '(':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000236 if (level == 0)
237 max++;
238 level++;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000239 if (level >= 30)
240 Py_FatalError("too many tuple nesting levels "
241 "in argument format string");
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000242 break;
243 case ')':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000244 if (level == 0)
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000245 Py_FatalError("excess ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000246 else
247 level--;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000248 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000249 case '\0':
250 endfmt = 1;
251 break;
252 case ':':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000253 fname = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000254 endfmt = 1;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000255 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000256 case ';':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000257 message = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000258 endfmt = 1;
259 break;
260 default:
261 if (level == 0) {
262 if (c == 'O')
263 max++;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000264 else if (isalpha(Py_CHARMASK(c))) {
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000265 if (c != 'e') /* skip encoded */
266 max++;
267 } else if (c == '|')
268 min = max;
269 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000270 break;
271 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000272 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000273
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000274 if (level != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000275 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000276
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000277 if (min < 0)
278 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000279
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000280 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000281
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000282 if (compat) {
283 if (max == 0) {
284 if (args == NULL)
285 return 1;
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000286 PyOS_snprintf(msgbuf, sizeof(msgbuf),
287 "%.200s%s takes no arguments",
288 fname==NULL ? "function" : fname,
289 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000290 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000291 return 0;
292 }
293 else if (min == 1 && max == 1) {
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000294 if (args == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000295 PyOS_snprintf(msgbuf, sizeof(msgbuf),
296 "%.200s%s takes at least one argument",
297 fname==NULL ? "function" : fname,
298 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000299 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000300 return 0;
301 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000302 msg = convertitem(args, &format, p_va, flags, levels,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000303 msgbuf, sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000304 if (msg == NULL)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000305 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000306 seterror(levels[0], msg, levels+1, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000307 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000308 }
309 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000310 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000311 "old style getargs format uses new features");
312 return 0;
313 }
314 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000315
Guido van Rossum79f25d91997-04-29 20:08:16 +0000316 if (!PyTuple_Check(args)) {
317 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000318 "new style getargs format but argument is not a tuple");
319 return 0;
320 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000321
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000322 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000323
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000324 if (len < min || max < len) {
325 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000326 PyOS_snprintf(msgbuf, sizeof(msgbuf),
327 "%.150s%s takes %s %d argument%s "
Neal Norwitz20dd93f2006-02-19 19:34:15 +0000328 "(%ld given)",
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000329 fname==NULL ? "function" : fname,
330 fname==NULL ? "" : "()",
331 min==max ? "exactly"
332 : len < min ? "at least" : "at most",
333 len < min ? min : max,
334 (len < min ? min : max) == 1 ? "" : "s",
Neal Norwitz9a276172006-02-20 18:57:39 +0000335 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000336 message = msgbuf;
337 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000338 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000339 return 0;
340 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000341
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000342 for (i = 0; i < len; i++) {
343 if (*format == '|')
344 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000345 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000346 flags, levels, msgbuf,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000347 sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000348 if (msg) {
349 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000350 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000351 }
352 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000353
Neal Norwitz4ac13df2005-12-19 06:10:07 +0000354 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
Guido van Rossum7d4f68c1997-12-19 04:25:23 +0000355 *format != '(' &&
Guido van Rossum231a41e1997-12-09 20:36:39 +0000356 *format != '|' && *format != ':' && *format != ';') {
357 PyErr_Format(PyExc_SystemError,
Guido van Rossum0d6b49e1998-01-19 22:22:44 +0000358 "bad format string: %.200s", formatsave);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000359 return cleanreturn(0, freelist);
Guido van Rossum231a41e1997-12-09 20:36:39 +0000360 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000361
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000362 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000363}
364
365
366
367static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000368seterror(int iarg, const char *msg, int *levels, const char *fname,
369 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000370{
Marc-André Lemburgd4c0a9c2001-11-28 11:47:00 +0000371 char buf[512];
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000372 int i;
373 char *p = buf;
374
Guido van Rossum79f25d91997-04-29 20:08:16 +0000375 if (PyErr_Occurred())
Guido van Rossum64fc6491995-01-21 14:09:37 +0000376 return;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000377 else if (message == NULL) {
378 if (fname != NULL) {
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000379 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000380 p += strlen(p);
381 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000382 if (iarg != 0) {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000383 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000384 "argument %d", iarg);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000385 i = 0;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000386 p += strlen(p);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000387 while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
388 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000389 ", item %d", levels[i]-1);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000390 p += strlen(p);
391 i++;
392 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000393 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000394 else {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000395 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
Ka-Ping Yee20579702001-01-15 22:14:16 +0000396 p += strlen(p);
397 }
Tim Petersfaad5ad2001-12-03 00:43:33 +0000398 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000399 message = buf;
400 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000401 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000402}
403
404
405/* Convert a tuple argument.
406 On entry, *p_format points to the character _after_ the opening '('.
407 On successful exit, *p_format points to the closing ')'.
408 If successful:
409 *p_format and *p_va are updated,
410 *levels and *msgbuf are untouched,
411 and NULL is returned.
412 If the argument is invalid:
413 *p_format is unchanged,
414 *p_va is undefined,
415 *levels is a 0-terminated list of item numbers,
416 *msgbuf contains an error message, whose format is:
Ka-Ping Yee20579702001-01-15 22:14:16 +0000417 "must be <typename1>, not <typename2>", where:
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000418 <typename1> is the name of the expected type, and
419 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000420 and msgbuf is returned.
421*/
422
423static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000424converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000425 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000426 PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000427{
428 int level = 0;
429 int n = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000430 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000431 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000432
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000433 for (;;) {
434 int c = *format++;
435 if (c == '(') {
436 if (level == 0)
437 n++;
438 level++;
439 }
440 else if (c == ')') {
441 if (level == 0)
442 break;
443 level--;
444 }
445 else if (c == ':' || c == ';' || c == '\0')
446 break;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000447 else if (level == 0 && isalpha(Py_CHARMASK(c)))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000448 n++;
449 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000450
Christian Heimes72b710a2008-05-26 13:28:38 +0000451 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000452 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000453 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000454 toplevel ? "expected %d arguments, not %.50s" :
455 "must be %d-item sequence, not %.50s",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000456 n,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000457 arg == Py_None ? "None" : arg->ob_type->tp_name);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000458 return msgbuf;
459 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000460
Jeremy Hylton03657cf2000-07-12 13:05:33 +0000461 if ((i = PySequence_Size(arg)) != n) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000462 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000463 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000464 toplevel ? "expected %d arguments, not %d" :
465 "must be sequence of length %d, not %d",
466 n, i);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000467 return msgbuf;
468 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000469
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000470 format = *p_format;
471 for (i = 0; i < n; i++) {
472 char *msg;
Guido van Rossum66368cc1999-02-17 23:16:43 +0000473 PyObject *item;
474 item = PySequence_GetItem(arg, i);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000475 if (item == NULL) {
476 PyErr_Clear();
477 levels[0] = i+1;
478 levels[1] = 0;
479 strncpy(msgbuf, "is not retrievable", bufsize);
480 return msgbuf;
481 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000482 msg = convertitem(item, &format, p_va, flags, levels+1,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000483 msgbuf, bufsize, freelist);
Guido van Rossum66368cc1999-02-17 23:16:43 +0000484 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
485 Py_XDECREF(item);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000486 if (msg != NULL) {
487 levels[0] = i+1;
488 return msg;
489 }
490 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000491
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000492 *p_format = format;
493 return NULL;
494}
495
496
497/* Convert a single item. */
498
499static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000500convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
501 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000502{
503 char *msg;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000504 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000505
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000506 if (*format == '(' /* ')' */) {
507 format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000508 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000509 bufsize, 0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000510 if (msg == NULL)
511 format++;
512 }
513 else {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000514 msg = convertsimple(arg, &format, p_va, flags,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000515 msgbuf, bufsize, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000516 if (msg != NULL)
517 levels[0] = 0;
518 }
519 if (msg == NULL)
520 *p_format = format;
521 return msg;
522}
523
524
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000525
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000526#define UNICODE_DEFAULT_ENCODING(arg) \
527 _PyUnicode_AsDefaultEncodedString(arg, NULL)
528
529/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000530
531static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000532converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000533{
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000534 assert(expected != NULL);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000535 assert(arg != NULL);
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000536 PyOS_snprintf(msgbuf, bufsize,
537 "must be %.50s, not %.50s", expected,
538 arg == Py_None ? "None" : arg->ob_type->tp_name);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000539 return msgbuf;
540}
541
542#define CONV_UNICODE "(unicode conversion error)"
543
Guido van Rossum45aecf42006-03-15 04:58:47 +0000544/* Explicitly check for float arguments when integers are expected.
545 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000546static int
547float_argument_error(PyObject *arg)
548{
Guido van Rossum45aecf42006-03-15 04:58:47 +0000549 if (PyFloat_Check(arg)) {
550 PyErr_SetString(PyExc_TypeError,
551 "integer argument expected, got float" );
Neil Schemenauer5042da62003-02-04 20:59:40 +0000552 return 1;
Guido van Rossum45aecf42006-03-15 04:58:47 +0000553 }
Neil Schemenauer5042da62003-02-04 20:59:40 +0000554 else
555 return 0;
556}
557
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000558/* Convert a non-tuple argument. Return NULL if conversion went OK,
559 or a string with a message describing the failure. The message is
560 formatted as "must be <desired type>, not <actual type>".
561 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000562 Don't call if a tuple is expected.
563
564 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000565*/
566
567static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000568convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000569 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000570{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000571 /* For # codes */
572#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
573 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
574 else q=va_arg(*p_va, int*);
575#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
576#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
577
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000578 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000579 char c = *format++;
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000580 PyObject *uarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000581
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000582 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000583
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000584 case 'b': { /* unsigned byte -- very short int */
585 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000586 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000587 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000588 return converterr("integer<b>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000589 ival = PyLong_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000590 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000591 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000592 else if (ival < 0) {
593 PyErr_SetString(PyExc_OverflowError,
594 "unsigned byte integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000595 return converterr("integer<b>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000596 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000597 else if (ival > UCHAR_MAX) {
598 PyErr_SetString(PyExc_OverflowError,
599 "unsigned byte integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000600 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000601 }
602 else
603 *p = (unsigned char) ival;
604 break;
605 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000606
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000607 case 'B': {/* byte sized bitfield - both signed and unsigned
Guido van Rossum98297ee2007-11-06 21:34:58 +0000608 values allowed */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000609 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000610 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000611 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000612 return converterr("integer<B>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000613 ival = PyLong_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000614 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000615 return converterr("integer<B>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000616 else
617 *p = (unsigned char) ival;
618 break;
619 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000620
Guido van Rossumfce26e72003-04-18 00:12:30 +0000621 case 'h': {/* signed short int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000622 short *p = va_arg(*p_va, short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000623 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000624 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000625 return converterr("integer<h>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000626 ival = PyLong_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000627 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000628 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfce26e72003-04-18 00:12:30 +0000629 else if (ival < SHRT_MIN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000630 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000631 "signed short integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000632 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000633 }
Guido van Rossumfce26e72003-04-18 00:12:30 +0000634 else if (ival > SHRT_MAX) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000635 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000636 "signed short integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000637 return converterr("integer<h>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000638 }
639 else
640 *p = (short) ival;
641 break;
642 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000643
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000644 case 'H': { /* short int sized bitfield, both signed and
Guido van Rossum98297ee2007-11-06 21:34:58 +0000645 unsigned allowed */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000646 unsigned short *p = va_arg(*p_va, unsigned short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000647 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000648 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000649 return converterr("integer<H>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000650 ival = PyLong_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000651 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000652 return converterr("integer<H>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000653 else
654 *p = (unsigned short) ival;
655 break;
656 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000657
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000658 case 'i': {/* signed int */
659 int *p = va_arg(*p_va, int *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000660 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000661 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000662 return converterr("integer<i>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000663 ival = PyLong_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000664 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000665 return converterr("integer<i>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000666 else if (ival > INT_MAX) {
667 PyErr_SetString(PyExc_OverflowError,
668 "signed integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000669 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000670 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000671 else if (ival < INT_MIN) {
672 PyErr_SetString(PyExc_OverflowError,
673 "signed integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000674 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000675 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000676 else
677 *p = ival;
678 break;
679 }
680
Thomas Hellera4ea6032003-04-17 18:55:45 +0000681 case 'I': { /* int sized bitfield, both signed and
Guido van Rossum98297ee2007-11-06 21:34:58 +0000682 unsigned allowed */
Thomas Hellera4ea6032003-04-17 18:55:45 +0000683 unsigned int *p = va_arg(*p_va, unsigned int *);
684 unsigned int ival;
685 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000686 return converterr("integer<I>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000687 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000688 if (ival == (unsigned int)-1 && PyErr_Occurred())
Thomas Hellera4ea6032003-04-17 18:55:45 +0000689 return converterr("integer<I>", arg, msgbuf, bufsize);
690 else
691 *p = ival;
692 break;
693 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000694
Martin v. Löwis18e16552006-02-15 17:27:45 +0000695 case 'n': /* Py_ssize_t */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000696 {
Neal Norwitzb879f572007-08-31 05:20:36 +0000697 PyObject *iobj;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000698 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
Neal Norwitzb879f572007-08-31 05:20:36 +0000699 Py_ssize_t ival = -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000700 if (float_argument_error(arg))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000701 return converterr("integer<n>", arg, msgbuf, bufsize);
Neal Norwitzb879f572007-08-31 05:20:36 +0000702 iobj = PyNumber_Index(arg);
Christian Heimesbcd2c082008-05-08 01:20:25 +0000703 if (iobj != NULL) {
Trent Nelson35133582008-04-22 19:02:40 +0000704 ival = PyLong_AsSsize_t(iobj);
Christian Heimesbcd2c082008-05-08 01:20:25 +0000705 Py_DECREF(iobj);
706 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000707 if (ival == -1 && PyErr_Occurred())
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000708 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000709 *p = ival;
710 break;
711 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000712 case 'l': {/* long int */
713 long *p = va_arg(*p_va, long *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000714 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000715 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000716 return converterr("integer<l>", arg, msgbuf, bufsize);
Christian Heimes217cfd12007-12-02 14:31:20 +0000717 ival = PyLong_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000718 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000719 return converterr("integer<l>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000720 else
721 *p = ival;
722 break;
723 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000724
725 case 'k': { /* long sized bitfield */
726 unsigned long *p = va_arg(*p_va, unsigned long *);
727 unsigned long ival;
Georg Brandle1a0d112007-10-23 19:24:22 +0000728 if (PyLong_Check(arg))
Thomas Hellera4ea6032003-04-17 18:55:45 +0000729 ival = PyLong_AsUnsignedLongMask(arg);
730 else
731 return converterr("integer<k>", arg, msgbuf, bufsize);
732 *p = ival;
733 break;
734 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000735
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000736#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000737 case 'L': {/* PY_LONG_LONG */
738 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
739 PY_LONG_LONG ival = PyLong_AsLongLong( arg );
Christian Heimes836baa52008-02-26 08:18:30 +0000740 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000741 return converterr("long<L>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000742 } else {
743 *p = ival;
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000744 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000745 break;
746 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000747
748 case 'K': { /* long long sized bitfield */
749 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
750 unsigned PY_LONG_LONG ival;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000751 if (PyLong_Check(arg))
Thomas Hellera4ea6032003-04-17 18:55:45 +0000752 ival = PyLong_AsUnsignedLongLongMask(arg);
753 else
754 return converterr("integer<K>", arg, msgbuf, bufsize);
755 *p = ival;
756 break;
757 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000758#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000759
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000760 case 'f': {/* float */
761 float *p = va_arg(*p_va, float *);
762 double dval = PyFloat_AsDouble(arg);
763 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000764 return converterr("float<f>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000765 else
766 *p = (float) dval;
767 break;
768 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000769
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000770 case 'd': {/* double */
771 double *p = va_arg(*p_va, double *);
772 double dval = PyFloat_AsDouble(arg);
773 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000774 return converterr("float<d>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000775 else
776 *p = dval;
777 break;
778 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000779
Guido van Rossum530956d1996-07-21 02:27:43 +0000780#ifndef WITHOUT_COMPLEX
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000781 case 'D': {/* complex double */
782 Py_complex *p = va_arg(*p_va, Py_complex *);
783 Py_complex cval;
784 cval = PyComplex_AsCComplex(arg);
785 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000786 return converterr("complex<D>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000787 else
788 *p = cval;
789 break;
790 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000791#endif /* WITHOUT_COMPLEX */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000792
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000793 case 'c': {/* char */
Walter Dörwaldd0941302007-07-01 21:58:22 +0000794 char *p = va_arg(*p_va, char *);
Christian Heimes72b710a2008-05-26 13:28:38 +0000795 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
796 *p = PyBytes_AS_STRING(arg)[0];
Walter Dörwaldd0941302007-07-01 21:58:22 +0000797 else
Benjamin Peterson7fe98532009-04-02 00:33:55 +0000798 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
Walter Dörwaldd0941302007-07-01 21:58:22 +0000799 break;
800 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000801
Walter Dörwaldd0941302007-07-01 21:58:22 +0000802 case 'C': {/* unicode char */
Walter Dörwaldbc1f8862007-06-20 11:02:38 +0000803 int *p = va_arg(*p_va, int *);
Benjamin Peterson7fe98532009-04-02 00:33:55 +0000804 if (PyUnicode_Check(arg) &&
805 PyUnicode_GET_SIZE(arg) == 1)
Guido van Rossum09dc34f2007-05-04 04:17:33 +0000806 *p = PyUnicode_AS_UNICODE(arg)[0];
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000807 else
Benjamin Peterson7fe98532009-04-02 00:33:55 +0000808 return converterr("a unicode character", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000809 break;
810 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000811
812 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w', 't' codes all
813 need to be cleaned up! */
814
815 case 's': {/* text string */
Martin v. Löwis423be952008-08-13 15:53:07 +0000816 if (*format == '*') {
817 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
818
819 if (PyUnicode_Check(arg)) {
820 uarg = UNICODE_DEFAULT_ENCODING(arg);
821 if (uarg == NULL)
822 return converterr(CONV_UNICODE,
823 arg, msgbuf, bufsize);
824 PyBuffer_FillInfo(p, arg,
825 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
826 1, 0);
827 }
828 else { /* any buffer-like object */
829 char *buf;
830 if (getbuffer(arg, p, &buf) < 0)
831 return converterr(buf, arg, msgbuf, bufsize);
832 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000833 if (addcleanup(p, freelist, cleanup_buffer)) {
834 return converterr(
835 "(cleanup problem)",
836 arg, msgbuf, bufsize);
837 }
Martin v. Löwis423be952008-08-13 15:53:07 +0000838 format++;
839 } else if (*format == '#') {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000840 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000841 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000842
843 if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000844 uarg = UNICODE_DEFAULT_ENCODING(arg);
845 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000846 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000847 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000848 *p = PyBytes_AS_STRING(uarg);
849 STORE_SIZE(PyBytes_GET_SIZE(uarg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000850 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000851 else { /* any buffer-like object */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000852 /* XXX Really? */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000853 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000854 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000855 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000856 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000857 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000858 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000859 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000860 } else {
861 char **p = va_arg(*p_va, char **);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000862
863 if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000864 uarg = UNICODE_DEFAULT_ENCODING(arg);
865 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000866 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000867 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000868 *p = PyBytes_AS_STRING(uarg);
Marc-André Lemburg6f15e572001-05-02 17:16:16 +0000869 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000870 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000871 return converterr("string", arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000872 if ((Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000873 return converterr("string without null bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000874 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000875 }
876 break;
877 }
878
Guido van Rossum98297ee2007-11-06 21:34:58 +0000879 case 'y': {/* any buffer-like object, but not PyUnicode */
880 void **p = (void **)va_arg(*p_va, char **);
881 char *buf;
Martin v. Löwis423be952008-08-13 15:53:07 +0000882 Py_ssize_t count;
883 if (*format == '*') {
884 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
885 return converterr(buf, arg, msgbuf, bufsize);
886 format++;
Antoine Pitrouf71995782008-08-29 18:37:05 +0000887 if (addcleanup(p, freelist, cleanup_buffer)) {
888 return converterr(
889 "(cleanup problem)",
890 arg, msgbuf, bufsize);
891 }
Martin v. Löwis423be952008-08-13 15:53:07 +0000892 break;
893 }
894 count = convertbuffer(arg, p, &buf);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000895 if (count < 0)
896 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis423be952008-08-13 15:53:07 +0000897 else if (*format == '#') {
Walter Dörwald612344f2007-05-04 19:28:21 +0000898 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000899 STORE_SIZE(count);
Walter Dörwald612344f2007-05-04 19:28:21 +0000900 format++;
Walter Dörwald612344f2007-05-04 19:28:21 +0000901 }
902 break;
903 }
904
Guido van Rossum98297ee2007-11-06 21:34:58 +0000905 case 'z': {/* like 's' or 's#', but None is okay, stored as NULL */
Martin v. Löwis423be952008-08-13 15:53:07 +0000906 if (*format == '*') {
907 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
908
909 if (arg == Py_None)
910 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
911 else if (PyUnicode_Check(arg)) {
912 uarg = UNICODE_DEFAULT_ENCODING(arg);
913 if (uarg == NULL)
914 return converterr(CONV_UNICODE,
915 arg, msgbuf, bufsize);
916 PyBuffer_FillInfo(p, arg,
917 PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
918 1, 0);
919 }
920 else { /* any buffer-like object */
921 char *buf;
922 if (getbuffer(arg, p, &buf) < 0)
923 return converterr(buf, arg, msgbuf, bufsize);
924 }
Antoine Pitrouf71995782008-08-29 18:37:05 +0000925 if (addcleanup(p, freelist, cleanup_buffer)) {
926 return converterr(
927 "(cleanup problem)",
928 arg, msgbuf, bufsize);
929 }
Martin v. Löwis423be952008-08-13 15:53:07 +0000930 format++;
931 } else if (*format == '#') { /* any buffer-like object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000932 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000933 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000934
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000935 if (arg == Py_None) {
936 *p = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000937 STORE_SIZE(0);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000938 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000939 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000940 uarg = UNICODE_DEFAULT_ENCODING(arg);
941 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000942 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000943 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000944 *p = PyBytes_AS_STRING(uarg);
945 STORE_SIZE(PyBytes_GET_SIZE(uarg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000946 }
947 else { /* any buffer-like object */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000948 /* XXX Really? */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000949 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000950 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000951 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000952 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000953 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000954 }
955 format++;
956 } else {
957 char **p = va_arg(*p_va, char **);
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +0000958 uarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000959
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000960 if (arg == Py_None)
961 *p = 0;
Christian Heimes72b710a2008-05-26 13:28:38 +0000962 else if (PyBytes_Check(arg)) {
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +0000963 /* Enable null byte check below */
964 uarg = arg;
Christian Heimes72b710a2008-05-26 13:28:38 +0000965 *p = PyBytes_AS_STRING(arg);
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +0000966 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000967 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000968 uarg = UNICODE_DEFAULT_ENCODING(arg);
969 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000970 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000971 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +0000972 *p = PyBytes_AS_STRING(uarg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000973 }
974 else
Guido van Rossum98297ee2007-11-06 21:34:58 +0000975 return converterr("string or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000976 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000977 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000978 FETCH_SIZE;
Thomas Woutersc3547a32006-03-01 21:31:21 +0000979 assert(0); /* XXX redundant with if-case */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000980 if (arg == Py_None) {
981 STORE_SIZE(0);
982 }
983 else {
Christian Heimes72b710a2008-05-26 13:28:38 +0000984 STORE_SIZE(PyBytes_Size(arg));
Guido van Rossum98297ee2007-11-06 21:34:58 +0000985 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000986 format++;
987 }
Amaury Forgeot d'Arc07404592008-05-12 13:19:07 +0000988 else if (*p != NULL && uarg != NULL &&
Christian Heimes72b710a2008-05-26 13:28:38 +0000989 (Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000990 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +0000991 "string without null bytes or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000992 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000993 }
994 break;
995 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000996
Guido van Rossumfb67be22007-08-29 18:38:11 +0000997 case 'Z': {/* unicode, may be NULL (None) */
998 if (*format == '#') { /* any buffer-like object */
999 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1000 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001001
Guido van Rossumfb67be22007-08-29 18:38:11 +00001002 if (arg == Py_None) {
1003 *p = 0;
1004 STORE_SIZE(0);
1005 }
1006 else if (PyUnicode_Check(arg)) {
1007 *p = PyUnicode_AS_UNICODE(arg);
1008 STORE_SIZE(PyUnicode_GET_SIZE(arg));
1009 }
1010 format++;
1011 } else {
1012 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001013
Guido van Rossumfb67be22007-08-29 18:38:11 +00001014 if (arg == Py_None)
1015 *p = 0;
1016 else if (PyUnicode_Check(arg))
1017 *p = PyUnicode_AS_UNICODE(arg);
1018 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001019 return converterr("string or None",
Guido van Rossumfb67be22007-08-29 18:38:11 +00001020 arg, msgbuf, bufsize);
1021 }
1022 break;
1023 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001024
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001025 case 'e': {/* encoded string */
1026 char **buffer;
1027 const char *encoding;
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001028 PyObject *s;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001029 int recode_strings;
1030 Py_ssize_t size;
Guido van Rossumd70539a2007-05-09 23:35:09 +00001031 const char *ptr;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001032
1033 /* Get 'e' parameter: the encoding name */
1034 encoding = (const char *)va_arg(*p_va, const char *);
1035 if (encoding == NULL)
1036 encoding = PyUnicode_GetDefaultEncoding();
Guido van Rossum98297ee2007-11-06 21:34:58 +00001037
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001038 /* Get output buffer parameter:
1039 's' (recode all objects via Unicode) or
Guido van Rossum98297ee2007-11-06 21:34:58 +00001040 't' (only recode non-string objects)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001041 */
1042 if (*format == 's')
1043 recode_strings = 1;
1044 else if (*format == 't')
1045 recode_strings = 0;
1046 else
1047 return converterr(
1048 "(unknown parser marker combination)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001049 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001050 buffer = (char **)va_arg(*p_va, char **);
1051 format++;
1052 if (buffer == NULL)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001053 return converterr("(buffer is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001054 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001055
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001056 /* Encode object */
Guido van Rossumd70539a2007-05-09 23:35:09 +00001057 if (!recode_strings &&
Christian Heimes72b710a2008-05-26 13:28:38 +00001058 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001059 s = arg;
1060 Py_INCREF(s);
Guido van Rossumd70539a2007-05-09 23:35:09 +00001061 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1062 return converterr("(AsCharBuffer failed)",
1063 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001064 }
1065 else {
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001066 PyObject *u;
1067
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001068 /* Convert object to Unicode */
1069 u = PyUnicode_FromObject(arg);
1070 if (u == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001071 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001072 "string or unicode or text buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001073 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001074
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001075 /* Encode object; use default error handling */
1076 s = PyUnicode_AsEncodedString(u,
1077 encoding,
1078 NULL);
1079 Py_DECREF(u);
1080 if (s == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001081 return converterr("(encoding failed)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001082 arg, msgbuf, bufsize);
Christian Heimes72b710a2008-05-26 13:28:38 +00001083 if (!PyBytes_Check(s)) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001084 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001085 return converterr(
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001086 "(encoder failed to return bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001087 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001088 }
Christian Heimes72b710a2008-05-26 13:28:38 +00001089 size = PyBytes_GET_SIZE(s);
1090 ptr = PyBytes_AS_STRING(s);
Guido van Rossumd70539a2007-05-09 23:35:09 +00001091 if (ptr == NULL)
1092 ptr = "";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001093 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001094
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001095 /* Write output; output is guaranteed to be 0-terminated */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001096 if (*format == '#') {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001097 /* Using buffer length parameter '#':
Guido van Rossum98297ee2007-11-06 21:34:58 +00001098
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001099 - if *buffer is NULL, a new buffer of the
1100 needed size is allocated and the data
1101 copied into it; *buffer is updated to point
1102 to the new buffer; the caller is
1103 responsible for PyMem_Free()ing it after
Guido van Rossum98297ee2007-11-06 21:34:58 +00001104 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001105
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001106 - if *buffer is not NULL, the data is
1107 copied to *buffer; *buffer_len has to be
1108 set to the size of the buffer on input;
1109 buffer overflow is signalled with an error;
1110 buffer has to provide enough room for the
1111 encoded string plus the trailing 0-byte
Guido van Rossum98297ee2007-11-06 21:34:58 +00001112
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001113 - in both cases, *buffer_len is updated to
1114 the size of the buffer /excluding/ the
Guido van Rossum98297ee2007-11-06 21:34:58 +00001115 trailing 0-byte
1116
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001117 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001118 FETCH_SIZE;
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001119
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001120 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001121 if (q == NULL && q2 == NULL) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001122 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001123 return converterr(
1124 "(buffer_len is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001125 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001126 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001127 if (*buffer == NULL) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001128 *buffer = PyMem_NEW(char, size + 1);
1129 if (*buffer == NULL) {
1130 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001131 return converterr(
1132 "(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001133 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +00001134 }
Antoine Pitrouf71995782008-08-29 18:37:05 +00001135 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001136 Py_DECREF(s);
1137 return converterr(
1138 "(cleanup problem)",
1139 arg, msgbuf, bufsize);
1140 }
Fred Drake25871c02000-05-03 15:17:02 +00001141 } else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001142 if (size + 1 > BUFFER_LEN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001143 Py_DECREF(s);
1144 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001145 "(buffer overflow)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001146 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001147 }
Fred Drake25871c02000-05-03 15:17:02 +00001148 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001149 memcpy(*buffer, ptr, size+1);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001150 STORE_SIZE(size);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001151 } else {
1152 /* Using a 0-terminated buffer:
Guido van Rossum98297ee2007-11-06 21:34:58 +00001153
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001154 - the encoded string has to be 0-terminated
1155 for this variant to work; if it is not, an
Guido van Rossum98297ee2007-11-06 21:34:58 +00001156 error raised
Fred Drake25871c02000-05-03 15:17:02 +00001157
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001158 - a new buffer of the needed size is
1159 allocated and the data copied into it;
1160 *buffer is updated to point to the new
1161 buffer; the caller is responsible for
1162 PyMem_Free()ing it after usage
1163
1164 */
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001165 if ((Py_ssize_t)strlen(ptr) != size) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001166 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001167 return converterr(
Benjamin Petersonef3e4c22009-04-11 19:48:14 +00001168 "encoded string without NULL bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001169 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001170 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001171 *buffer = PyMem_NEW(char, size + 1);
1172 if (*buffer == NULL) {
1173 Py_DECREF(s);
1174 return converterr("(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001175 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001176 }
Antoine Pitrouf71995782008-08-29 18:37:05 +00001177 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001178 Py_DECREF(s);
1179 return converterr("(cleanup problem)",
1180 arg, msgbuf, bufsize);
1181 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001182 memcpy(*buffer, ptr, size+1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001183 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001184 Py_DECREF(s);
1185 break;
1186 }
1187
1188 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001189 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1190 if (!PyUnicode_Check(arg))
1191 return converterr("str", arg, msgbuf, bufsize);
1192 *p = PyUnicode_AS_UNICODE(arg);
1193 if (*format == '#') { /* store pointer and size */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001194 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001195 STORE_SIZE(PyUnicode_GET_SIZE(arg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001196 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001197 }
1198 break;
1199 }
1200
Christian Heimes72b710a2008-05-26 13:28:38 +00001201 case 'S': { /* PyBytes object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001202 PyObject **p = va_arg(*p_va, PyObject **);
Christian Heimes72b710a2008-05-26 13:28:38 +00001203 if (PyBytes_Check(arg))
Guido van Rossum617dbc42007-05-07 23:57:08 +00001204 *p = arg;
1205 else
1206 return converterr("bytes", arg, msgbuf, bufsize);
1207 break;
1208 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001209
Christian Heimes9c4756e2008-05-26 13:22:05 +00001210 case 'Y': { /* PyByteArray object */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001211 PyObject **p = va_arg(*p_va, PyObject **);
Christian Heimes9c4756e2008-05-26 13:22:05 +00001212 if (PyByteArray_Check(arg))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001213 *p = arg;
1214 else
1215 return converterr("buffer", arg, msgbuf, bufsize);
1216 break;
1217 }
1218
1219 case 'U': { /* PyUnicode object */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001220 PyObject **p = va_arg(*p_va, PyObject **);
1221 if (PyUnicode_Check(arg))
1222 *p = arg;
1223 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001224 return converterr("str", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001225 break;
1226 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001227
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001228 case 'O': { /* object */
1229 PyTypeObject *type;
1230 PyObject **p;
1231 if (*format == '!') {
1232 type = va_arg(*p_va, PyTypeObject*);
1233 p = va_arg(*p_va, PyObject **);
1234 format++;
Guido van Rossumcbfc8552001-08-28 16:37:51 +00001235 if (PyType_IsSubtype(arg->ob_type, type))
Guido van Rossume826ef02000-03-10 23:02:17 +00001236 *p = arg;
1237 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001238 return converterr(type->tp_name, arg, msgbuf, bufsize);
Guido van Rossumfccfe891998-05-15 22:04:07 +00001239
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001240 }
1241 else if (*format == '?') {
1242 inquiry pred = va_arg(*p_va, inquiry);
1243 p = va_arg(*p_va, PyObject **);
1244 format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001245 if ((*pred)(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001246 *p = arg;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001247 else
Guido van Rossum98297ee2007-11-06 21:34:58 +00001248 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001249 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001250
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001251 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001252 else if (*format == '&') {
1253 typedef int (*converter)(PyObject *, void *);
1254 converter convert = va_arg(*p_va, converter);
1255 void *addr = va_arg(*p_va, void *);
1256 format++;
1257 if (! (*convert)(arg, addr))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001258 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001259 arg, msgbuf, bufsize);
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001260 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001261 else {
1262 p = va_arg(*p_va, PyObject **);
1263 *p = arg;
1264 }
1265 break;
1266 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001267
1268
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001269 case 'w': { /* memory buffer, read-write access */
1270 void **p = va_arg(*p_va, void **);
1271 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Christian Heimes4e30a842007-11-30 22:12:06 +00001272 Py_ssize_t count;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001273 int temp=-1;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001274 Py_buffer view;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001275
Martin v. Löwis423be952008-08-13 15:53:07 +00001276 if (pb && pb->bf_releasebuffer && *format != '*')
1277 /* Buffer must be released, yet caller does not use
1278 the Py_buffer protocol. */
1279 return converterr("pinned buffer", arg, msgbuf, bufsize);
1280
1281
1282 if (pb && pb->bf_getbuffer && *format == '*') {
1283 /* Caller is interested in Py_buffer, and the object
1284 supports it directly. */
1285 format++;
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001286 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
Martin v. Löwis423be952008-08-13 15:53:07 +00001287 PyErr_Clear();
1288 return converterr("read-write buffer", arg, msgbuf, bufsize);
1289 }
Antoine Pitrouf71995782008-08-29 18:37:05 +00001290 if (addcleanup(p, freelist, cleanup_buffer)) {
1291 return converterr(
1292 "(cleanup problem)",
1293 arg, msgbuf, bufsize);
1294 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001295 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C'))
1296 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1297 break;
1298 }
1299
1300 /* Here we have processed w*, only w and w# remain. */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001301 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001302 pb->bf_getbuffer == NULL ||
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001303 ((temp = PyObject_GetBuffer(arg, &view,
1304 PyBUF_SIMPLE)) != 0) ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001305 view.readonly == 1) {
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001306 if (temp==0) {
1307 PyBuffer_Release(&view);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001308 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001309 return converterr("single-segment read-write buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001310 arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001311 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001312
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001313 if ((count = view.len) < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001314 return converterr("(unspecified)", arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001315 *p = view.buf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001316 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001317 FETCH_SIZE;
1318 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001319 format++;
1320 }
1321 break;
1322 }
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001323
1324 /*TEO: This can be eliminated --- here only for backward
1325 compatibility */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001326 case 't': { /* 8-bit character buffer, read-only access */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001327 char **p = va_arg(*p_va, char **);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001328 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Christian Heimes4e30a842007-11-30 22:12:06 +00001329 Py_ssize_t count;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001330 Py_buffer view;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001331
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001332 if (*format++ != '#')
1333 return converterr(
Guido van Rossum98297ee2007-11-06 21:34:58 +00001334 "invalid use of 't' format character",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001335 arg, msgbuf, bufsize);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001336 if (pb == NULL || pb->bf_getbuffer == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001337 return converterr(
Alexandre Vassalotti70a23712007-10-14 02:05:51 +00001338 "bytes or read-only character buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001339 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001340
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001341 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001342 return converterr("string or single-segment read-only buffer",
1343 arg, msgbuf, bufsize);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001344
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001345 count = view.len;
1346 *p = view.buf;
Martin v. Löwis423be952008-08-13 15:53:07 +00001347 if (pb->bf_releasebuffer)
1348 return converterr(
1349 "string or pinned buffer",
1350 arg, msgbuf, bufsize);
1351
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001352 PyBuffer_Release(&view);
1353
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001354 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001355 return converterr("(unspecified)", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001356 {
1357 FETCH_SIZE;
1358 STORE_SIZE(count);
1359 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001360 break;
1361 }
1362
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001363 default:
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001364 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001365
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001366 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001367
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001368 *p_format = format;
1369 return NULL;
1370}
Guido van Rossumaa354651996-08-19 19:32:04 +00001371
Martin v. Löwis18e16552006-02-15 17:27:45 +00001372static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001373convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001374{
1375 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001376 Py_ssize_t count;
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001377 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001378
1379 *errmsg = NULL;
1380 *p = NULL;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001381 if (pb == NULL ||
Martin v. Löwis423be952008-08-13 15:53:07 +00001382 pb->bf_getbuffer == NULL ||
1383 pb->bf_releasebuffer != NULL) {
Guido van Rossumb0834002007-11-21 21:53:51 +00001384 *errmsg = "bytes or read-only buffer";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001385 return -1;
1386 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001387
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001388 if (PyObject_GetBuffer(arg, &view, PyBUF_SIMPLE) != 0) {
Guido van Rossumb0834002007-11-21 21:53:51 +00001389 *errmsg = "bytes or single-segment read-only buffer";
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001390 return -1;
1391 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001392 count = view.len;
1393 *p = view.buf;
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001394 PyBuffer_Release(&view);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001395 return count;
1396}
Guido van Rossumaa354651996-08-19 19:32:04 +00001397
Martin v. Löwis423be952008-08-13 15:53:07 +00001398/* XXX for 3.x, getbuffer and convertbuffer can probably
1399 be merged again. */
1400static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001401getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001402{
1403 void *buf;
1404 Py_ssize_t count;
1405 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1406 if (pb == NULL) {
Benjamin Peterson81d90a22008-12-27 02:58:34 +00001407 *errmsg = "bytes or buffer";
Martin v. Löwis423be952008-08-13 15:53:07 +00001408 return -1;
1409 }
1410 if (pb->bf_getbuffer) {
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001411 if (PyObject_GetBuffer(arg, view, 0) < 0) {
Neal Norwitz2f99b242008-08-24 05:48:10 +00001412 *errmsg = "convertible to a buffer";
Martin v. Löwis423be952008-08-13 15:53:07 +00001413 return -1;
Neal Norwitz2f99b242008-08-24 05:48:10 +00001414 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001415 if (!PyBuffer_IsContiguous(view, 'C')) {
1416 *errmsg = "contiguous buffer";
1417 return -1;
1418 }
1419 return 0;
1420 }
1421
1422 count = convertbuffer(arg, &buf, errmsg);
Neal Norwitz2f99b242008-08-24 05:48:10 +00001423 if (count < 0) {
1424 *errmsg = "convertible to a buffer";
Martin v. Löwis423be952008-08-13 15:53:07 +00001425 return count;
Neal Norwitz2f99b242008-08-24 05:48:10 +00001426 }
Martin v. Löwis423be952008-08-13 15:53:07 +00001427 PyBuffer_FillInfo(view, NULL, buf, count, 1, 0);
1428 return 0;
1429}
1430
Guido van Rossumaa354651996-08-19 19:32:04 +00001431/* Support for keyword arguments donated by
1432 Geoff Philbrick <philbric@delphi.hks.com> */
1433
Tim Petersf8cd3e82001-10-27 04:26:57 +00001434/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001435int
1436PyArg_ParseTupleAndKeywords(PyObject *args,
1437 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001438 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001439 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001440{
1441 int retval;
1442 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001443
1444 if ((args == NULL || !PyTuple_Check(args)) ||
1445 (keywords != NULL && !PyDict_Check(keywords)) ||
1446 format == NULL ||
1447 kwlist == NULL)
1448 {
1449 PyErr_BadInternalCall();
Tim Petersf8cd3e82001-10-27 04:26:57 +00001450 return 0;
Tim Peters45772cd2001-10-27 03:58:40 +00001451 }
1452
Guido van Rossumaa354651996-08-19 19:32:04 +00001453 va_start(va, kwlist);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001454 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001455 va_end(va);
1456 return retval;
1457}
1458
1459int
1460_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1461 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001462 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001463 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001464{
1465 int retval;
1466 va_list va;
1467
1468 if ((args == NULL || !PyTuple_Check(args)) ||
1469 (keywords != NULL && !PyDict_Check(keywords)) ||
1470 format == NULL ||
1471 kwlist == NULL)
1472 {
1473 PyErr_BadInternalCall();
1474 return 0;
1475 }
1476
1477 va_start(va, kwlist);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001478 retval = vgetargskeywords(args, keywords, format,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001479 kwlist, &va, FLAG_SIZE_T);
Guido van Rossumaa354651996-08-19 19:32:04 +00001480 va_end(va);
1481 return retval;
1482}
1483
1484
Brett Cannon711e7d92004-07-10 22:20:32 +00001485int
1486PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001487 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001488 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001489 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001490{
1491 int retval;
1492 va_list lva;
1493
1494 if ((args == NULL || !PyTuple_Check(args)) ||
1495 (keywords != NULL && !PyDict_Check(keywords)) ||
1496 format == NULL ||
1497 kwlist == NULL)
1498 {
1499 PyErr_BadInternalCall();
1500 return 0;
1501 }
1502
1503#ifdef VA_LIST_IS_ARRAY
1504 memcpy(lva, va, sizeof(va_list));
1505#else
1506#ifdef __va_copy
1507 __va_copy(lva, va);
1508#else
1509 lva = va;
1510#endif
1511#endif
1512
Guido van Rossum98297ee2007-11-06 21:34:58 +00001513 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001514 return retval;
1515}
1516
1517int
1518_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1519 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001520 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001521 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001522{
1523 int retval;
1524 va_list lva;
1525
1526 if ((args == NULL || !PyTuple_Check(args)) ||
1527 (keywords != NULL && !PyDict_Check(keywords)) ||
1528 format == NULL ||
1529 kwlist == NULL)
1530 {
1531 PyErr_BadInternalCall();
1532 return 0;
1533 }
1534
1535#ifdef VA_LIST_IS_ARRAY
1536 memcpy(lva, va, sizeof(va_list));
1537#else
1538#ifdef __va_copy
1539 __va_copy(lva, va);
1540#else
1541 lva = va;
1542#endif
1543#endif
1544
Guido van Rossum98297ee2007-11-06 21:34:58 +00001545 retval = vgetargskeywords(args, keywords, format,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001546 kwlist, &lva, FLAG_SIZE_T);
Brett Cannon711e7d92004-07-10 22:20:32 +00001547 return retval;
1548}
1549
Christian Heimes380f7f22008-02-28 11:19:05 +00001550#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001551
Guido van Rossumaa354651996-08-19 19:32:04 +00001552static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001553vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001554 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001555{
Tim Petersdc5eff92001-10-27 06:53:00 +00001556 char msgbuf[512];
Guido van Rossumaa354651996-08-19 19:32:04 +00001557 int levels[32];
Christian Heimes380f7f22008-02-28 11:19:05 +00001558 const char *fname, *msg, *custom_msg, *keyword;
1559 int min = INT_MAX;
Tim Petersb639d492001-10-27 07:00:56 +00001560 int i, len, nargs, nkeywords;
Christian Heimes380f7f22008-02-28 11:19:05 +00001561 PyObject *freelist = NULL, *current_arg;
Tim Petersf4331c12001-10-27 00:17:34 +00001562
Tim Peters45772cd2001-10-27 03:58:40 +00001563 assert(args != NULL && PyTuple_Check(args));
1564 assert(keywords == NULL || PyDict_Check(keywords));
1565 assert(format != NULL);
1566 assert(kwlist != NULL);
1567 assert(p_va != NULL);
1568
Christian Heimes380f7f22008-02-28 11:19:05 +00001569 /* grab the function name or custom error msg first (mutually exclusive) */
1570 fname = strchr(format, ':');
1571 if (fname) {
1572 fname++;
1573 custom_msg = NULL;
Tim Peters62d48e12001-10-27 06:42:16 +00001574 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001575 else {
1576 custom_msg = strchr(format,';');
1577 if (custom_msg)
1578 custom_msg++;
Tim Peters62d48e12001-10-27 06:42:16 +00001579 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001580
1581 /* scan kwlist and get greatest possible nbr of args */
1582 for (len=0; kwlist[len]; len++)
1583 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001584
Tim Peters6fb26352001-10-27 04:38:11 +00001585 nargs = PyTuple_GET_SIZE(args);
Christian Heimes380f7f22008-02-28 11:19:05 +00001586 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1587 if (nargs + nkeywords > len) {
1588 PyErr_Format(PyExc_TypeError, "%s%s takes at most %d "
1589 "argument%s (%d given)",
1590 (fname == NULL) ? "function" : fname,
1591 (fname == NULL) ? "" : "()",
1592 len,
1593 (len == 1) ? "" : "s",
1594 nargs + nkeywords);
Guido van Rossumaa354651996-08-19 19:32:04 +00001595 return 0;
1596 }
Tim Petersc2f01122001-10-27 07:25:06 +00001597
Christian Heimes380f7f22008-02-28 11:19:05 +00001598 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1599 for (i = 0; i < len; i++) {
1600 keyword = kwlist[i];
1601 if (*format == '|') {
1602 min = i;
Guido van Rossumaa354651996-08-19 19:32:04 +00001603 format++;
Christian Heimes380f7f22008-02-28 11:19:05 +00001604 }
1605 if (IS_END_OF_FORMAT(*format)) {
1606 PyErr_Format(PyExc_RuntimeError,
1607 "More keyword list entries (%d) than "
1608 "format specifiers (%d)", len, i);
1609 return cleanreturn(0, freelist);
1610 }
1611 current_arg = NULL;
1612 if (nkeywords) {
1613 current_arg = PyDict_GetItemString(keywords, keyword);
1614 }
1615 if (current_arg) {
1616 --nkeywords;
1617 if (i < nargs) {
1618 /* arg present in tuple and in dict */
1619 PyErr_Format(PyExc_TypeError,
1620 "Argument given by name ('%s') "
1621 "and position (%d)",
1622 keyword, i+1);
1623 return cleanreturn(0, freelist);
1624 }
1625 }
1626 else if (nkeywords && PyErr_Occurred())
1627 return cleanreturn(0, freelist);
1628 else if (i < nargs)
1629 current_arg = PyTuple_GET_ITEM(args, i);
1630
1631 if (current_arg) {
1632 msg = convertitem(current_arg, &format, p_va, flags,
1633 levels, msgbuf, sizeof(msgbuf), &freelist);
1634 if (msg) {
1635 seterror(i+1, msg, levels, fname, custom_msg);
1636 return cleanreturn(0, freelist);
1637 }
1638 continue;
1639 }
1640
1641 if (i < min) {
1642 PyErr_Format(PyExc_TypeError, "Required argument "
1643 "'%s' (pos %d) not found",
1644 keyword, i+1);
1645 return cleanreturn(0, freelist);
1646 }
1647 /* current code reports success when all required args
1648 * fulfilled and no keyword args left, with no further
1649 * validation. XXX Maybe skip this in debug build ?
1650 */
1651 if (!nkeywords)
1652 return cleanreturn(1, freelist);
1653
1654 /* We are into optional args, skip thru to any remaining
1655 * keyword args */
1656 msg = skipitem(&format, p_va, flags);
Guido van Rossumaa354651996-08-19 19:32:04 +00001657 if (msg) {
Christian Heimes380f7f22008-02-28 11:19:05 +00001658 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1659 format);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001660 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001661 }
1662 }
1663
Benjamin Peterson92035012008-12-27 16:00:54 +00001664 if (!IS_END_OF_FORMAT(*format) && *format != '|') {
Christian Heimes380f7f22008-02-28 11:19:05 +00001665 PyErr_Format(PyExc_RuntimeError,
1666 "more argument specifiers than keyword list entries "
1667 "(remaining format:'%s')", format);
1668 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001669 }
Tim Petersb054be42001-10-27 05:07:41 +00001670
Guido van Rossumaa354651996-08-19 19:32:04 +00001671 /* make sure there are no extraneous keyword arguments */
Tim Petersc2f01122001-10-27 07:25:06 +00001672 if (nkeywords > 0) {
1673 PyObject *key, *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001674 Py_ssize_t pos = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001675 while (PyDict_Next(keywords, &pos, &key, &value)) {
Tim Petersc2f01122001-10-27 07:25:06 +00001676 int match = 0;
Guido van Rossum55474762002-04-04 16:22:30 +00001677 char *ks;
Georg Brandld8b690f2008-05-16 17:28:50 +00001678 if (!PyUnicode_Check(key)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00001679 PyErr_SetString(PyExc_TypeError,
Guido van Rossum55474762002-04-04 16:22:30 +00001680 "keywords must be strings");
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001681 return cleanreturn(0, freelist);
Guido van Rossum55474762002-04-04 16:22:30 +00001682 }
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001683 ks = _PyUnicode_AsString(key);
Christian Heimes380f7f22008-02-28 11:19:05 +00001684 for (i = 0; i < len; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001685 if (!strcmp(ks, kwlist[i])) {
1686 match = 1;
1687 break;
1688 }
1689 }
1690 if (!match) {
Tim Petersc2f01122001-10-27 07:25:06 +00001691 PyErr_Format(PyExc_TypeError,
1692 "'%s' is an invalid keyword "
1693 "argument for this function",
1694 ks);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001695 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001696 }
1697 }
1698 }
Tim Petersc2f01122001-10-27 07:25:06 +00001699
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001700 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001701}
1702
1703
1704static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001705skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001706{
Christian Heimes380f7f22008-02-28 11:19:05 +00001707 const char *format = *p_format;
Guido van Rossumaa354651996-08-19 19:32:04 +00001708 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001709
Guido van Rossumaa354651996-08-19 19:32:04 +00001710 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001711
1712 /* simple codes
1713 * The individual types (second arg of va_arg) are irrelevant */
1714
Guido van Rossumaa354651996-08-19 19:32:04 +00001715 case 'b': /* byte -- very short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001716 case 'B': /* byte as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001717 case 'h': /* short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001718 case 'H': /* short int as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001719 case 'i': /* int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001720 case 'I': /* int sized bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001721 case 'l': /* long int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001722 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001723#ifdef HAVE_LONG_LONG
Georg Brandl6dd14612005-09-14 19:29:53 +00001724 case 'L': /* PY_LONG_LONG */
1725 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001726#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001727 case 'f': /* float */
Guido van Rossumaa354651996-08-19 19:32:04 +00001728 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001729#ifndef WITHOUT_COMPLEX
1730 case 'D': /* complex double */
Georg Brandl6dd14612005-09-14 19:29:53 +00001731#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001732 case 'c': /* char */
1733 {
Georg Brandl6dd14612005-09-14 19:29:53 +00001734 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001735 break;
1736 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001737
1738 case 'n': /* Py_ssize_t */
1739 {
1740 (void) va_arg(*p_va, Py_ssize_t *);
1741 break;
1742 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001743
Georg Brandl6dd14612005-09-14 19:29:53 +00001744 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001745
Georg Brandl6dd14612005-09-14 19:29:53 +00001746 case 'e': /* string with encoding */
1747 {
1748 (void) va_arg(*p_va, const char *);
1749 if (!(*format == 's' || *format == 't'))
1750 /* after 'e', only 's' and 't' is allowed */
1751 goto err;
1752 format++;
1753 /* explicit fallthrough to string cases */
1754 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001755
Guido van Rossumaa354651996-08-19 19:32:04 +00001756 case 's': /* string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001757 case 'z': /* string or None */
Walter Dörwald612344f2007-05-04 19:28:21 +00001758 case 'y': /* bytes */
Georg Brandl6dd14612005-09-14 19:29:53 +00001759 case 'u': /* unicode string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001760 case 't': /* buffer, read-only */
1761 case 'w': /* buffer, read-write */
Guido van Rossumaa354651996-08-19 19:32:04 +00001762 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001763 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001764 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001765 if (flags & FLAG_SIZE_T)
1766 (void) va_arg(*p_va, Py_ssize_t *);
1767 else
1768 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001769 format++;
Martin v. Löwis423be952008-08-13 15:53:07 +00001770 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1771 format++;
Guido van Rossumaa354651996-08-19 19:32:04 +00001772 }
1773 break;
1774 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001775
1776 /* object codes */
1777
Guido van Rossumaa354651996-08-19 19:32:04 +00001778 case 'S': /* string object */
Guido van Rossum617dbc42007-05-07 23:57:08 +00001779 case 'Y': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001780 case 'U': /* unicode string object */
Guido van Rossumaa354651996-08-19 19:32:04 +00001781 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001782 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001783 break;
1784 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001785
Guido van Rossumaa354651996-08-19 19:32:04 +00001786 case 'O': /* object */
1787 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001788 if (*format == '!') {
1789 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001790 (void) va_arg(*p_va, PyTypeObject*);
1791 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001792 }
1793#if 0
1794/* I don't know what this is for */
1795 else if (*format == '?') {
1796 inquiry pred = va_arg(*p_va, inquiry);
1797 format++;
1798 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001799 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001800 }
1801 }
1802#endif
1803 else if (*format == '&') {
Tim Petersdbd9ba62000-07-09 03:09:57 +00001804 typedef int (*converter)(PyObject *, void *);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001805 (void) va_arg(*p_va, converter);
1806 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001807 format++;
1808 }
1809 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001810 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001811 }
1812 break;
1813 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001814
Christian Heimes380f7f22008-02-28 11:19:05 +00001815 case '(': /* bypass tuple, not handled at all previously */
1816 {
1817 char *msg;
1818 for (;;) {
1819 if (*format==')')
1820 break;
1821 if (IS_END_OF_FORMAT(*format))
1822 return "Unmatched left paren in format "
1823 "string";
1824 msg = skipitem(&format, p_va, flags);
1825 if (msg)
1826 return msg;
1827 }
1828 format++;
1829 break;
1830 }
1831
1832 case ')':
1833 return "Unmatched right paren in format string";
1834
Guido van Rossumaa354651996-08-19 19:32:04 +00001835 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001836err:
Guido van Rossumaa354651996-08-19 19:32:04 +00001837 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001838
Guido van Rossumaa354651996-08-19 19:32:04 +00001839 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001840
Guido van Rossumaa354651996-08-19 19:32:04 +00001841 *p_format = format;
1842 return NULL;
1843}
Fred Drakee4616e62001-10-23 21:09:29 +00001844
1845
1846int
Martin v. Löwis76246742006-03-01 04:06:10 +00001847PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001848{
Martin v. Löwis76246742006-03-01 04:06:10 +00001849 Py_ssize_t i, l;
Fred Drakee4616e62001-10-23 21:09:29 +00001850 PyObject **o;
1851 va_list vargs;
1852
1853#ifdef HAVE_STDARG_PROTOTYPES
1854 va_start(vargs, max);
1855#else
1856 va_start(vargs);
1857#endif
1858
1859 assert(min >= 0);
1860 assert(min <= max);
1861 if (!PyTuple_Check(args)) {
1862 PyErr_SetString(PyExc_SystemError,
1863 "PyArg_UnpackTuple() argument list is not a tuple");
1864 return 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001865 }
Fred Drakee4616e62001-10-23 21:09:29 +00001866 l = PyTuple_GET_SIZE(args);
1867 if (l < min) {
1868 if (name != NULL)
1869 PyErr_Format(
1870 PyExc_TypeError,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001871 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001872 name, (min == max ? "" : "at least "), min, l);
1873 else
1874 PyErr_Format(
1875 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001876 "unpacked tuple should have %s%zd elements,"
Guido van Rossum98297ee2007-11-06 21:34:58 +00001877 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001878 (min == max ? "" : "at least "), min, l);
1879 va_end(vargs);
1880 return 0;
1881 }
1882 if (l > max) {
1883 if (name != NULL)
1884 PyErr_Format(
1885 PyExc_TypeError,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001886 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001887 name, (min == max ? "" : "at most "), max, l);
1888 else
1889 PyErr_Format(
1890 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001891 "unpacked tuple should have %s%zd elements,"
Guido van Rossum98297ee2007-11-06 21:34:58 +00001892 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001893 (min == max ? "" : "at most "), max, l);
1894 va_end(vargs);
1895 return 0;
1896 }
1897 for (i = 0; i < l; i++) {
1898 o = va_arg(vargs, PyObject **);
1899 *o = PyTuple_GET_ITEM(args, i);
1900 }
1901 va_end(vargs);
1902 return 1;
1903}
Georg Brandl02c42872005-08-26 06:42:30 +00001904
1905
1906/* For type constructors that don't take keyword args
1907 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001908 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001909 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001910 */
1911int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001912_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001913{
1914 if (kw == NULL)
1915 return 1;
1916 if (!PyDict_CheckExact(kw)) {
1917 PyErr_BadInternalCall();
1918 return 0;
1919 }
1920 if (PyDict_Size(kw) == 0)
1921 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001922
1923 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
Georg Brandl02c42872005-08-26 06:42:30 +00001924 funcname);
1925 return 0;
1926}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001927#ifdef __cplusplus
1928};
1929#endif