blob: 60845680fc2a562ed13b64821436f9a2bb0ce04b [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 *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000017 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000018int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040036typedef int (*destr_t)(PyObject *, void *);
37
38
39/* Keep track of "objects" that have been allocated or initialized and
40 which will need to be deallocated or cleaned up somehow if overall
41 parsing fails.
42*/
43typedef struct {
44 void *item;
45 destr_t destructor;
46} freelistentry_t;
47
48typedef struct {
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040049 freelistentry_t *entries;
Antoine Pitrou7056cb22013-02-17 01:04:57 +010050 int first_available;
51 int entries_malloced;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040052} freelist_t;
53
Antoine Pitrou7056cb22013-02-17 01:04:57 +010054#define STATIC_FREELIST_ENTRIES 8
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000055
56/* Forward */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000057static int vgetargs1(PyObject *, const char *, va_list *, int);
Victor Stinner84bb1cf2013-05-17 00:12:04 +020058static void seterror(Py_ssize_t, const char *, int *, const char *, const char *);
Guido van Rossum98297ee2007-11-06 21:34:58 +000059static char *convertitem(PyObject *, const char **, va_list *, int, int *,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040060 char *, size_t, freelist_t *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000061static char *converttuple(PyObject *, const char **, va_list *, int,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040062 int *, char *, size_t, int, freelist_t *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000063static char *convertsimple(PyObject *, const char **, va_list *, int, char *,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040064 size_t, freelist_t *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000065static Py_ssize_t convertbuffer(PyObject *, void **p, char **);
Martin v. Löwis423be952008-08-13 15:53:07 +000066static int getbuffer(PyObject *, Py_buffer *, char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000067
Tim Petersdbd9ba62000-07-09 03:09:57 +000068static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000069 const char *, char **, va_list *, int);
Martin v. Löwis18e16552006-02-15 17:27:45 +000070static char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000071
Fred Drake563dfc22001-10-23 14:41:08 +000072int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000073PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000074{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000075 int retval;
76 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000078 va_start(va, format);
79 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
80 va_end(va);
81 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +000082}
83
84int
85_PyArg_Parse_SizeT(PyObject *args, char *format, ...)
86{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000087 int retval;
88 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000089
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000090 va_start(va, format);
91 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
92 va_end(va);
93 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000094}
95
96
Fred Drake563dfc22001-10-23 14:41:08 +000097int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000098PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000100 int retval;
101 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000103 va_start(va, format);
104 retval = vgetargs1(args, format, &va, 0);
105 va_end(va);
106 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000107}
108
Martin v. Löwis18e16552006-02-15 17:27:45 +0000109int
110_PyArg_ParseTuple_SizeT(PyObject *args, char *format, ...)
111{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 int retval;
113 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 va_start(va, format);
116 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
117 va_end(va);
118 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000119}
120
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000121
122int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000123PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000124{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000125 va_list lva;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000126
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000127 Py_VA_COPY(lva, va);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000128
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000129 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000130}
131
Martin v. Löwis18e16552006-02-15 17:27:45 +0000132int
133_PyArg_VaParse_SizeT(PyObject *args, char *format, va_list va)
134{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000135 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000136
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000137 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000139 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000140}
141
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000142
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000143/* Handle cleanup of allocated memory in case of exception */
144
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400145static int
146cleanup_ptr(PyObject *self, void *ptr)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000147{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000148 if (ptr) {
149 PyMem_FREE(ptr);
150 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000151 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000152}
153
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000154static int
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400155cleanup_buffer(PyObject *self, void *ptr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000156{
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400157 Py_buffer *buf = (Py_buffer *)ptr;
158 if (buf) {
159 PyBuffer_Release(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000160 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400161 return 0;
162}
163
164static int
165addcleanup(void *ptr, freelist_t *freelist, destr_t destructor)
166{
167 int index;
168
169 index = freelist->first_available;
170 freelist->first_available += 1;
171
172 freelist->entries[index].item = ptr;
173 freelist->entries[index].destructor = destructor;
174
175 return 0;
176}
177
178static int
179cleanreturn(int retval, freelist_t *freelist)
180{
181 int index;
182
183 if (retval == 0) {
184 /* A failure occurred, therefore execute all of the cleanup
185 functions.
186 */
187 for (index = 0; index < freelist->first_available; ++index) {
188 freelist->entries[index].destructor(NULL,
189 freelist->entries[index].item);
190 }
191 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100192 if (freelist->entries_malloced)
193 PyMem_FREE(freelist->entries);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000194 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000195}
196
197
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000198static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000199vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000200{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000201 char msgbuf[256];
202 int levels[32];
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100203 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
204 freelist_t freelist = {static_entries, 0, 0};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000205 const char *fname = NULL;
206 const char *message = NULL;
207 int min = -1;
208 int max = 0;
209 int level = 0;
210 int endfmt = 0;
211 const char *formatsave = format;
212 Py_ssize_t i, len;
213 char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000214 int compat = flags & FLAG_COMPAT;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000215
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000216 assert(compat || (args != (PyObject*)NULL));
217 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000218
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000219 while (endfmt == 0) {
220 int c = *format++;
221 switch (c) {
222 case '(':
223 if (level == 0)
224 max++;
225 level++;
226 if (level >= 30)
227 Py_FatalError("too many tuple nesting levels "
228 "in argument format string");
229 break;
230 case ')':
231 if (level == 0)
232 Py_FatalError("excess ')' in getargs format");
233 else
234 level--;
235 break;
236 case '\0':
237 endfmt = 1;
238 break;
239 case ':':
240 fname = format;
241 endfmt = 1;
242 break;
243 case ';':
244 message = format;
245 endfmt = 1;
246 break;
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100247 case '|':
248 if (level == 0)
249 min = max;
250 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000251 default:
252 if (level == 0) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100253 if (Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000254 if (c != 'e') /* skip encoded */
255 max++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000256 }
257 break;
258 }
259 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000260
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000261 if (level != 0)
262 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000263
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000264 if (min < 0)
265 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000267 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000268
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100269 if (max > STATIC_FREELIST_ENTRIES) {
270 freelist.entries = PyMem_NEW(freelistentry_t, max);
271 if (freelist.entries == NULL) {
272 PyErr_NoMemory();
273 return 0;
274 }
275 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -0500276 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400277
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000278 if (compat) {
279 if (max == 0) {
280 if (args == NULL)
281 return 1;
Victor Stinner6ced7c42011-03-21 18:15:42 +0100282 PyErr_Format(PyExc_TypeError,
283 "%.200s%s takes no arguments",
284 fname==NULL ? "function" : fname,
285 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400286 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000287 }
288 else if (min == 1 && max == 1) {
289 if (args == NULL) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100290 PyErr_Format(PyExc_TypeError,
291 "%.200s%s takes at least one argument",
292 fname==NULL ? "function" : fname,
293 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400294 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000295 }
296 msg = convertitem(args, &format, p_va, flags, levels,
297 msgbuf, sizeof(msgbuf), &freelist);
298 if (msg == NULL)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400299 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000300 seterror(levels[0], msg, levels+1, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400301 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000302 }
303 else {
304 PyErr_SetString(PyExc_SystemError,
305 "old style getargs format uses new features");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400306 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 }
308 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000309
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000310 if (!PyTuple_Check(args)) {
311 PyErr_SetString(PyExc_SystemError,
312 "new style getargs format but argument is not a tuple");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400313 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000314 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000315
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000318 if (len < min || max < len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100319 if (message == NULL)
320 PyErr_Format(PyExc_TypeError,
321 "%.150s%s takes %s %d argument%s (%ld given)",
322 fname==NULL ? "function" : fname,
323 fname==NULL ? "" : "()",
324 min==max ? "exactly"
325 : len < min ? "at least" : "at most",
326 len < min ? min : max,
327 (len < min ? min : max) == 1 ? "" : "s",
328 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
329 else
330 PyErr_SetString(PyExc_TypeError, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400331 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000332 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000333
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000334 for (i = 0; i < len; i++) {
335 if (*format == '|')
336 format++;
337 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
338 flags, levels, msgbuf,
339 sizeof(msgbuf), &freelist);
340 if (msg) {
341 seterror(i+1, msg, levels, fname, msg);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400342 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 }
344 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000345
Antoine Pitrou4de74572013-02-09 23:11:27 +0100346 if (*format != '\0' && !Py_ISALPHA(Py_CHARMASK(*format)) &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 *format != '(' &&
348 *format != '|' && *format != ':' && *format != ';') {
349 PyErr_Format(PyExc_SystemError,
350 "bad format string: %.200s", formatsave);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400351 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000352 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000353
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400354 return cleanreturn(1, &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000355}
356
357
358
359static void
Victor Stinner84bb1cf2013-05-17 00:12:04 +0200360seterror(Py_ssize_t iarg, const char *msg, int *levels, const char *fname,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000361 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000362{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000363 char buf[512];
364 int i;
365 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 if (PyErr_Occurred())
368 return;
369 else if (message == NULL) {
370 if (fname != NULL) {
371 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
372 p += strlen(p);
373 }
374 if (iarg != 0) {
375 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Richard Oudkerk25296ce2013-05-18 17:35:19 +0100376 "argument %" PY_FORMAT_SIZE_T "d", iarg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 i = 0;
378 p += strlen(p);
Georg Brandl142ad662013-10-14 07:01:11 +0200379 while (i < 32 && levels[i] > 0 && (int)(p-buf) < 220) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000380 PyOS_snprintf(p, sizeof(buf) - (p - buf),
381 ", item %d", levels[i]-1);
382 p += strlen(p);
383 i++;
384 }
385 }
386 else {
387 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
388 p += strlen(p);
389 }
390 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
391 message = buf;
392 }
393 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000394}
395
396
397/* Convert a tuple argument.
398 On entry, *p_format points to the character _after_ the opening '('.
399 On successful exit, *p_format points to the closing ')'.
400 If successful:
401 *p_format and *p_va are updated,
402 *levels and *msgbuf are untouched,
403 and NULL is returned.
404 If the argument is invalid:
405 *p_format is unchanged,
406 *p_va is undefined,
407 *levels is a 0-terminated list of item numbers,
408 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 "must be <typename1>, not <typename2>", where:
410 <typename1> is the name of the expected type, and
411 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000412 and msgbuf is returned.
413*/
414
415static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000416converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000417 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400418 freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000419{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 int level = 0;
421 int n = 0;
422 const char *format = *p_format;
423 int i;
Victor Stinner74387f52013-11-18 01:21:12 +0100424 Py_ssize_t len;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000425
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000426 for (;;) {
427 int c = *format++;
428 if (c == '(') {
429 if (level == 0)
430 n++;
431 level++;
432 }
433 else if (c == ')') {
434 if (level == 0)
435 break;
436 level--;
437 }
438 else if (c == ':' || c == ';' || c == '\0')
439 break;
Antoine Pitrou4de74572013-02-09 23:11:27 +0100440 else if (level == 0 && Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000441 n++;
442 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
445 levels[0] = 0;
446 PyOS_snprintf(msgbuf, bufsize,
447 toplevel ? "expected %d arguments, not %.50s" :
448 "must be %d-item sequence, not %.50s",
449 n,
450 arg == Py_None ? "None" : arg->ob_type->tp_name);
451 return msgbuf;
452 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000453
Victor Stinner74387f52013-11-18 01:21:12 +0100454 len = PySequence_Size(arg);
455 if (len != n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 levels[0] = 0;
Victor Stinner74387f52013-11-18 01:21:12 +0100457 if (toplevel) {
458 PyOS_snprintf(msgbuf, bufsize,
459 "expected %d arguments, not %" PY_FORMAT_SIZE_T "d",
460 n, len);
461 }
462 else {
463 PyOS_snprintf(msgbuf, bufsize,
464 "must be sequence of length %d, "
465 "not %" PY_FORMAT_SIZE_T "d",
466 n, len);
467 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000468 return msgbuf;
469 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000471 format = *p_format;
472 for (i = 0; i < n; i++) {
473 char *msg;
474 PyObject *item;
475 item = PySequence_GetItem(arg, i);
476 if (item == NULL) {
477 PyErr_Clear();
478 levels[0] = i+1;
479 levels[1] = 0;
480 strncpy(msgbuf, "is not retrievable", bufsize);
481 return msgbuf;
482 }
483 msg = convertitem(item, &format, p_va, flags, levels+1,
484 msgbuf, bufsize, freelist);
485 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
486 Py_XDECREF(item);
487 if (msg != NULL) {
488 levels[0] = i+1;
489 return msg;
490 }
491 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000493 *p_format = format;
494 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000495}
496
497
498/* Convert a single item. */
499
500static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000501convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400502 int *levels, char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000503{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 char *msg;
505 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 if (*format == '(' /* ')' */) {
508 format++;
509 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
510 bufsize, 0, freelist);
511 if (msg == NULL)
512 format++;
513 }
514 else {
515 msg = convertsimple(arg, &format, p_va, flags,
516 msgbuf, bufsize, freelist);
517 if (msg != NULL)
518 levels[0] = 0;
519 }
520 if (msg == NULL)
521 *p_format = format;
522 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000523}
524
525
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000526
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000527/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000528
529static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000530converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000531{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000532 assert(expected != NULL);
533 assert(arg != NULL);
534 PyOS_snprintf(msgbuf, bufsize,
535 "must be %.50s, not %.50s", expected,
536 arg == Py_None ? "None" : arg->ob_type->tp_name);
537 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000538}
539
540#define CONV_UNICODE "(unicode conversion error)"
541
Guido van Rossum45aecf42006-03-15 04:58:47 +0000542/* Explicitly check for float arguments when integers are expected.
543 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000544static int
545float_argument_error(PyObject *arg)
546{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000547 if (PyFloat_Check(arg)) {
548 PyErr_SetString(PyExc_TypeError,
549 "integer argument expected, got float" );
550 return 1;
551 }
552 else
553 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000554}
555
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000556/* Convert a non-tuple argument. Return NULL if conversion went OK,
557 or a string with a message describing the failure. The message is
558 formatted as "must be <desired type>, not <actual type>".
559 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000560 Don't call if a tuple is expected.
561
562 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000563*/
564
565static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000566convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400567 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000568{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000569 /* For # codes */
570#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
571 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
572 else q=va_arg(*p_va, int*);
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000573#define STORE_SIZE(s) \
574 if (flags & FLAG_SIZE_T) \
575 *q2=s; \
576 else { \
577 if (INT_MAX < s) { \
578 PyErr_SetString(PyExc_OverflowError, \
579 "size does not fit in an int"); \
580 return converterr("", arg, msgbuf, bufsize); \
581 } \
Victor Stinner9550ef32013-06-05 01:18:13 +0200582 *q = (int)s; \
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000583 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000584#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000585#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000586
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000587 const char *format = *p_format;
588 char c = *format++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200589 char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000590
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000591 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000593 case 'b': { /* unsigned byte -- very short int */
594 char *p = va_arg(*p_va, char *);
595 long ival;
596 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000597 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 ival = PyLong_AsLong(arg);
599 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000600 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000601 else if (ival < 0) {
602 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000603 "unsigned byte integer is less than minimum");
604 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000605 }
606 else if (ival > UCHAR_MAX) {
607 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000608 "unsigned byte integer is greater than maximum");
609 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000610 }
611 else
612 *p = (unsigned char) ival;
613 break;
614 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000615
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000616 case 'B': {/* byte sized bitfield - both signed and unsigned
617 values allowed */
618 char *p = va_arg(*p_va, char *);
619 long ival;
620 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000621 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000622 ival = PyLong_AsUnsignedLongMask(arg);
623 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000624 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 else
626 *p = (unsigned char) ival;
627 break;
628 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000629
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000630 case 'h': {/* signed short int */
631 short *p = va_arg(*p_va, short *);
632 long ival;
633 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000634 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000635 ival = PyLong_AsLong(arg);
636 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000637 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000638 else if (ival < SHRT_MIN) {
639 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000640 "signed short integer is less than minimum");
641 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000642 }
643 else if (ival > SHRT_MAX) {
644 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000645 "signed short integer is greater than maximum");
646 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000647 }
648 else
649 *p = (short) ival;
650 break;
651 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000652
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000653 case 'H': { /* short int sized bitfield, both signed and
654 unsigned allowed */
655 unsigned short *p = va_arg(*p_va, unsigned short *);
656 long ival;
657 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000658 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000659 ival = PyLong_AsUnsignedLongMask(arg);
660 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000661 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000662 else
663 *p = (unsigned short) ival;
664 break;
665 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000666
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000667 case 'i': {/* signed int */
668 int *p = va_arg(*p_va, int *);
669 long ival;
670 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000671 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000672 ival = PyLong_AsLong(arg);
673 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000674 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 else if (ival > INT_MAX) {
676 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000677 "signed integer is greater than maximum");
678 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000679 }
680 else if (ival < INT_MIN) {
681 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000682 "signed integer is less than minimum");
683 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000684 }
685 else
686 *p = ival;
687 break;
688 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000689
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000690 case 'I': { /* int sized bitfield, both signed and
691 unsigned allowed */
692 unsigned int *p = va_arg(*p_va, unsigned int *);
693 unsigned int ival;
694 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000695 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000696 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
697 if (ival == (unsigned int)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000698 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 else
700 *p = ival;
701 break;
702 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000703
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000704 case 'n': /* Py_ssize_t */
705 {
706 PyObject *iobj;
707 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
708 Py_ssize_t ival = -1;
709 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000710 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 iobj = PyNumber_Index(arg);
712 if (iobj != NULL) {
713 ival = PyLong_AsSsize_t(iobj);
714 Py_DECREF(iobj);
715 }
716 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000717 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 *p = ival;
719 break;
720 }
721 case 'l': {/* long int */
722 long *p = va_arg(*p_va, long *);
723 long ival;
724 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000725 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 ival = PyLong_AsLong(arg);
727 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000728 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 else
730 *p = ival;
731 break;
732 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 case 'k': { /* long sized bitfield */
735 unsigned long *p = va_arg(*p_va, unsigned long *);
736 unsigned long ival;
737 if (PyLong_Check(arg))
738 ival = PyLong_AsUnsignedLongMask(arg);
739 else
740 return converterr("integer<k>", arg, msgbuf, bufsize);
741 *p = ival;
742 break;
743 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000744
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000745#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 case 'L': {/* PY_LONG_LONG */
747 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
748 PY_LONG_LONG ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000749 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000750 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000751 ival = PyLong_AsLongLong(arg);
Mark Dickinsonc7301312010-06-10 16:05:10 +0000752 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000753 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000754 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000756 break;
757 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000758
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 case 'K': { /* long long sized bitfield */
760 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
761 unsigned PY_LONG_LONG ival;
762 if (PyLong_Check(arg))
763 ival = PyLong_AsUnsignedLongLongMask(arg);
764 else
765 return converterr("integer<K>", arg, msgbuf, bufsize);
766 *p = ival;
767 break;
768 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000769#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000770
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 case 'f': {/* float */
772 float *p = va_arg(*p_va, float *);
773 double dval = PyFloat_AsDouble(arg);
774 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000775 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000776 else
777 *p = (float) dval;
778 break;
779 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000780
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 case 'd': {/* double */
782 double *p = va_arg(*p_va, double *);
783 double dval = PyFloat_AsDouble(arg);
784 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000785 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000786 else
787 *p = dval;
788 break;
789 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000791 case 'D': {/* complex double */
792 Py_complex *p = va_arg(*p_va, Py_complex *);
793 Py_complex cval;
794 cval = PyComplex_AsCComplex(arg);
795 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000796 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000797 else
798 *p = cval;
799 break;
800 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000802 case 'c': {/* char */
803 char *p = va_arg(*p_va, char *);
804 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
805 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300806 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
807 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 else
809 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
810 break;
811 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000812
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 case 'C': {/* unicode char */
814 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200815 int kind;
816 void *data;
817
818 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200820
821 if (PyUnicode_READY(arg))
822 RETURN_ERR_OCCURRED;
823
824 if (PyUnicode_GET_LENGTH(arg) != 1)
825 return converterr("a unicode character", arg, msgbuf, bufsize);
826
827 kind = PyUnicode_KIND(arg);
828 data = PyUnicode_DATA(arg);
829 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 break;
831 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000832
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700833 case 'p': {/* boolean *p*redicate */
834 int *p = va_arg(*p_va, int *);
835 int val = PyObject_IsTrue(arg);
836 if (val > 0)
837 *p = 1;
838 else if (val == 0)
839 *p = 0;
840 else
841 RETURN_ERR_OCCURRED;
842 break;
843 }
844
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000845 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 case 'y': {/* any buffer-like object, but not PyUnicode */
849 void **p = (void **)va_arg(*p_va, char **);
850 char *buf;
851 Py_ssize_t count;
852 if (*format == '*') {
853 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
854 return converterr(buf, arg, msgbuf, bufsize);
855 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400856 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 return converterr(
858 "(cleanup problem)",
859 arg, msgbuf, bufsize);
860 }
861 break;
862 }
863 count = convertbuffer(arg, p, &buf);
864 if (count < 0)
865 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000866 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 FETCH_SIZE;
868 STORE_SIZE(count);
869 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000870 } else {
871 if (strlen(*p) != count)
872 return converterr(
873 "bytes without null bytes",
874 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000875 }
876 break;
877 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000878
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000879 case 's': /* text string */
880 case 'z': /* text string or None */
881 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000882 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000883 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000885
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000886 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000887 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
888 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200889 Py_ssize_t len;
890 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
891 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000892 return converterr(CONV_UNICODE,
893 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200894 PyBuffer_FillInfo(p, arg, sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000895 }
896 else { /* any buffer-like object */
897 char *buf;
898 if (getbuffer(arg, p, &buf) < 0)
899 return converterr(buf, arg, msgbuf, bufsize);
900 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400901 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000902 return converterr(
903 "(cleanup problem)",
904 arg, msgbuf, bufsize);
905 }
906 format++;
907 } else if (*format == '#') { /* any buffer-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000908 /* "s#" or "z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 void **p = (void **)va_arg(*p_va, char **);
910 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000911
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000912 if (c == 'z' && arg == Py_None) {
913 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000914 STORE_SIZE(0);
915 }
916 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200917 Py_ssize_t len;
918 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
919 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000920 return converterr(CONV_UNICODE,
921 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200922 *p = sarg;
923 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000924 }
925 else { /* any buffer-like object */
926 /* XXX Really? */
927 char *buf;
928 Py_ssize_t count = convertbuffer(arg, p, &buf);
929 if (count < 0)
930 return converterr(buf, arg, msgbuf, bufsize);
931 STORE_SIZE(count);
932 }
933 format++;
934 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000935 /* "s" or "z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000936 char **p = va_arg(*p_va, char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200937 Py_ssize_t len;
938 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000939
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000940 if (c == 'z' && arg == Py_None)
941 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200943 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
944 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000945 return converterr(CONV_UNICODE,
946 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200947 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000948 }
949 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000950 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200952 if (*p != NULL && sarg != NULL && (Py_ssize_t) strlen(*p) != len)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000953 return converterr(
Victor Stinner9d663d02011-10-13 23:25:03 +0200954 c == 'z' ? "str without null characters or None"
955 : "str without null characters",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 arg, msgbuf, bufsize);
957 }
958 break;
959 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000960
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000961 case 'u': /* raw unicode buffer (Py_UNICODE *) */
962 case 'Z': /* raw unicode buffer or None */
963 {
Brett Cannonb94767f2011-02-22 20:15:44 +0000964 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000966 if (*format == '#') { /* any buffer-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000967 /* "s#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000969
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000970 if (c == 'Z' && arg == Py_None) {
971 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 STORE_SIZE(0);
973 }
974 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200975 Py_ssize_t len;
976 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200977 if (*p == NULL)
978 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200979 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 }
Victor Stinner5216e6d2010-06-08 21:45:51 +0000981 else
982 return converterr("str or None", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000983 format++;
984 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000985 /* "s" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000986 if (c == 'Z' && arg == Py_None)
987 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000988 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200989 Py_ssize_t len;
990 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200991 if (*p == NULL)
992 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200993 if (Py_UNICODE_strlen(*p) != len)
Victor Stinner06e49dd2010-06-13 18:21:50 +0000994 return converterr(
Victor Stinner9d663d02011-10-13 23:25:03 +0200995 "str without null characters or None",
Victor Stinner06e49dd2010-06-13 18:21:50 +0000996 arg, msgbuf, bufsize);
997 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000998 return converterr(c == 'Z' ? "str or None" : "str",
999 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001000 }
1001 break;
1002 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001003
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001004 case 'e': {/* encoded string */
1005 char **buffer;
1006 const char *encoding;
1007 PyObject *s;
1008 int recode_strings;
1009 Py_ssize_t size;
1010 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001011
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001012 /* Get 'e' parameter: the encoding name */
1013 encoding = (const char *)va_arg(*p_va, const char *);
1014 if (encoding == NULL)
1015 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 /* Get output buffer parameter:
1018 's' (recode all objects via Unicode) or
1019 't' (only recode non-string objects)
1020 */
1021 if (*format == 's')
1022 recode_strings = 1;
1023 else if (*format == 't')
1024 recode_strings = 0;
1025 else
1026 return converterr(
1027 "(unknown parser marker combination)",
1028 arg, msgbuf, bufsize);
1029 buffer = (char **)va_arg(*p_va, char **);
1030 format++;
1031 if (buffer == NULL)
1032 return converterr("(buffer is NULL)",
1033 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001034
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001035 /* Encode object */
1036 if (!recode_strings &&
1037 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1038 s = arg;
1039 Py_INCREF(s);
1040 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1041 return converterr("(AsCharBuffer failed)",
1042 arg, msgbuf, bufsize);
1043 }
1044 else {
1045 PyObject *u;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001046
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001047 /* Convert object to Unicode */
1048 u = PyUnicode_FromObject(arg);
1049 if (u == NULL)
1050 return converterr(
1051 "string or unicode or text buffer",
1052 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001053
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001054 /* Encode object; use default error handling */
1055 s = PyUnicode_AsEncodedString(u,
1056 encoding,
1057 NULL);
1058 Py_DECREF(u);
1059 if (s == NULL)
1060 return converterr("(encoding failed)",
1061 arg, msgbuf, bufsize);
1062 if (!PyBytes_Check(s)) {
1063 Py_DECREF(s);
1064 return converterr(
1065 "(encoder failed to return bytes)",
1066 arg, msgbuf, bufsize);
1067 }
1068 size = PyBytes_GET_SIZE(s);
1069 ptr = PyBytes_AS_STRING(s);
1070 if (ptr == NULL)
1071 ptr = "";
1072 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001073
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001074 /* Write output; output is guaranteed to be 0-terminated */
1075 if (*format == '#') {
1076 /* Using buffer length parameter '#':
1077
1078 - if *buffer is NULL, a new buffer of the
1079 needed size is allocated and the data
1080 copied into it; *buffer is updated to point
1081 to the new buffer; the caller is
1082 responsible for PyMem_Free()ing it after
1083 usage
1084
1085 - if *buffer is not NULL, the data is
1086 copied to *buffer; *buffer_len has to be
1087 set to the size of the buffer on input;
1088 buffer overflow is signalled with an error;
1089 buffer has to provide enough room for the
1090 encoded string plus the trailing 0-byte
1091
1092 - in both cases, *buffer_len is updated to
1093 the size of the buffer /excluding/ the
1094 trailing 0-byte
1095
1096 */
1097 FETCH_SIZE;
1098
1099 format++;
1100 if (q == NULL && q2 == NULL) {
1101 Py_DECREF(s);
1102 return converterr(
1103 "(buffer_len is NULL)",
1104 arg, msgbuf, bufsize);
1105 }
1106 if (*buffer == NULL) {
1107 *buffer = PyMem_NEW(char, size + 1);
1108 if (*buffer == NULL) {
1109 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001110 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001111 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001112 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001113 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 Py_DECREF(s);
1115 return converterr(
1116 "(cleanup problem)",
1117 arg, msgbuf, bufsize);
1118 }
1119 } else {
1120 if (size + 1 > BUFFER_LEN) {
1121 Py_DECREF(s);
1122 return converterr(
1123 "(buffer overflow)",
1124 arg, msgbuf, bufsize);
1125 }
1126 }
1127 memcpy(*buffer, ptr, size+1);
1128 STORE_SIZE(size);
1129 } else {
1130 /* Using a 0-terminated buffer:
1131
1132 - the encoded string has to be 0-terminated
1133 for this variant to work; if it is not, an
1134 error raised
1135
1136 - a new buffer of the needed size is
1137 allocated and the data copied into it;
1138 *buffer is updated to point to the new
1139 buffer; the caller is responsible for
1140 PyMem_Free()ing it after usage
1141
1142 */
1143 if ((Py_ssize_t)strlen(ptr) != size) {
1144 Py_DECREF(s);
1145 return converterr(
1146 "encoded string without NULL bytes",
1147 arg, msgbuf, bufsize);
1148 }
1149 *buffer = PyMem_NEW(char, size + 1);
1150 if (*buffer == NULL) {
1151 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001152 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001153 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001154 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001155 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 Py_DECREF(s);
1157 return converterr("(cleanup problem)",
1158 arg, msgbuf, bufsize);
1159 }
1160 memcpy(*buffer, ptr, size+1);
1161 }
1162 Py_DECREF(s);
1163 break;
1164 }
1165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 case 'S': { /* PyBytes object */
1167 PyObject **p = va_arg(*p_va, PyObject **);
1168 if (PyBytes_Check(arg))
1169 *p = arg;
1170 else
1171 return converterr("bytes", arg, msgbuf, bufsize);
1172 break;
1173 }
1174
1175 case 'Y': { /* PyByteArray object */
1176 PyObject **p = va_arg(*p_va, PyObject **);
1177 if (PyByteArray_Check(arg))
1178 *p = arg;
1179 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001180 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001181 break;
1182 }
1183
1184 case 'U': { /* PyUnicode object */
1185 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001186 if (PyUnicode_Check(arg)) {
1187 if (PyUnicode_READY(arg) == -1)
1188 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001190 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001191 else
1192 return converterr("str", arg, msgbuf, bufsize);
1193 break;
1194 }
1195
1196 case 'O': { /* object */
1197 PyTypeObject *type;
1198 PyObject **p;
1199 if (*format == '!') {
1200 type = va_arg(*p_va, PyTypeObject*);
1201 p = va_arg(*p_va, PyObject **);
1202 format++;
1203 if (PyType_IsSubtype(arg->ob_type, type))
1204 *p = arg;
1205 else
1206 return converterr(type->tp_name, arg, msgbuf, bufsize);
1207
1208 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001209 else if (*format == '&') {
1210 typedef int (*converter)(PyObject *, void *);
1211 converter convert = va_arg(*p_va, converter);
1212 void *addr = va_arg(*p_va, void *);
1213 int res;
1214 format++;
1215 if (! (res = (*convert)(arg, addr)))
1216 return converterr("(unspecified)",
1217 arg, msgbuf, bufsize);
1218 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001219 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001220 return converterr("(cleanup problem)",
1221 arg, msgbuf, bufsize);
1222 }
1223 else {
1224 p = va_arg(*p_va, PyObject **);
1225 *p = arg;
1226 }
1227 break;
1228 }
1229
1230
Victor Stinner25e8ec42010-06-25 00:02:38 +00001231 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001232 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001233
Victor Stinner25e8ec42010-06-25 00:02:38 +00001234 if (*format != '*')
1235 return converterr(
1236 "invalid use of 'w' format character",
1237 arg, msgbuf, bufsize);
1238 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001239
Victor Stinner25e8ec42010-06-25 00:02:38 +00001240 /* Caller is interested in Py_buffer, and the object
1241 supports it directly. */
1242 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1243 PyErr_Clear();
1244 return converterr("read-write buffer", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 }
Victor Stinner8182b712010-07-28 00:40:58 +00001246 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1247 PyBuffer_Release((Py_buffer*)p);
1248 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1249 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001250 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001251 return converterr(
1252 "(cleanup problem)",
1253 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001254 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001255 break;
1256 }
1257
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001258 default:
1259 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
1260
1261 }
1262
1263 *p_format = format;
1264 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001265
1266#undef FETCH_SIZE
1267#undef STORE_SIZE
1268#undef BUFFER_LEN
1269#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001270}
Guido van Rossumaa354651996-08-19 19:32:04 +00001271
Martin v. Löwis18e16552006-02-15 17:27:45 +00001272static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001273convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001274{
Victor Stinner5cb62392010-06-06 20:27:51 +00001275 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001276 Py_ssize_t count;
1277 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001279 *errmsg = NULL;
1280 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001281 if (pb != NULL && pb->bf_releasebuffer != NULL) {
1282 *errmsg = "read-only pinned buffer";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001283 return -1;
1284 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001285
Victor Stinner8182b712010-07-28 00:40:58 +00001286 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001287 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001288 count = view.len;
1289 *p = view.buf;
1290 PyBuffer_Release(&view);
1291 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001292}
Guido van Rossumaa354651996-08-19 19:32:04 +00001293
Martin v. Löwis423be952008-08-13 15:53:07 +00001294static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001295getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001296{
Victor Stinner8182b712010-07-28 00:40:58 +00001297 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001298 *errmsg = "bytes or buffer";
1299 return -1;
1300 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001301 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001302 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001303 *errmsg = "contiguous buffer";
1304 return -1;
1305 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001306 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001307}
1308
Guido van Rossumaa354651996-08-19 19:32:04 +00001309/* Support for keyword arguments donated by
1310 Geoff Philbrick <philbric@delphi.hks.com> */
1311
Tim Petersf8cd3e82001-10-27 04:26:57 +00001312/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001313int
1314PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001315 PyObject *keywords,
1316 const char *format,
1317 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001318{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001319 int retval;
1320 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001321
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001322 if ((args == NULL || !PyTuple_Check(args)) ||
1323 (keywords != NULL && !PyDict_Check(keywords)) ||
1324 format == NULL ||
1325 kwlist == NULL)
1326 {
1327 PyErr_BadInternalCall();
1328 return 0;
1329 }
Tim Peters45772cd2001-10-27 03:58:40 +00001330
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001331 va_start(va, kwlist);
1332 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1333 va_end(va);
1334 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001335}
1336
1337int
1338_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001339 PyObject *keywords,
1340 const char *format,
1341 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001342{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001343 int retval;
1344 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001345
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 if ((args == NULL || !PyTuple_Check(args)) ||
1347 (keywords != NULL && !PyDict_Check(keywords)) ||
1348 format == NULL ||
1349 kwlist == NULL)
1350 {
1351 PyErr_BadInternalCall();
1352 return 0;
1353 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001354
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001355 va_start(va, kwlist);
1356 retval = vgetargskeywords(args, keywords, format,
1357 kwlist, &va, FLAG_SIZE_T);
1358 va_end(va);
1359 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001360}
1361
1362
Brett Cannon711e7d92004-07-10 22:20:32 +00001363int
1364PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001365 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001366 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001367 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001368{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001369 int retval;
1370 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 if ((args == NULL || !PyTuple_Check(args)) ||
1373 (keywords != NULL && !PyDict_Check(keywords)) ||
1374 format == NULL ||
1375 kwlist == NULL)
1376 {
1377 PyErr_BadInternalCall();
1378 return 0;
1379 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001380
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001381 Py_VA_COPY(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001382
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001383 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1384 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001385}
1386
1387int
1388_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001389 PyObject *keywords,
1390 const char *format,
1391 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001392{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001393 int retval;
1394 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001395
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001396 if ((args == NULL || !PyTuple_Check(args)) ||
1397 (keywords != NULL && !PyDict_Check(keywords)) ||
1398 format == NULL ||
1399 kwlist == NULL)
1400 {
1401 PyErr_BadInternalCall();
1402 return 0;
1403 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001404
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001405 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001406
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001407 retval = vgetargskeywords(args, keywords, format,
1408 kwlist, &lva, FLAG_SIZE_T);
1409 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001410}
1411
Benjamin Petersonfb886362010-04-24 18:21:17 +00001412int
1413PyArg_ValidateKeywordArguments(PyObject *kwargs)
1414{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001415 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001416 PyErr_BadInternalCall();
1417 return 0;
1418 }
1419 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1420 PyErr_SetString(PyExc_TypeError,
1421 "keyword arguments must be strings");
1422 return 0;
1423 }
1424 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001425}
1426
Christian Heimes380f7f22008-02-28 11:19:05 +00001427#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001428
Guido van Rossumaa354651996-08-19 19:32:04 +00001429static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001430vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001431 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001432{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 char msgbuf[512];
1434 int levels[32];
1435 const char *fname, *msg, *custom_msg, *keyword;
1436 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001437 int max = INT_MAX;
Victor Stinner74387f52013-11-18 01:21:12 +01001438 int i, len;
1439 Py_ssize_t nargs, nkeywords;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001440 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001441 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
1442 freelist_t freelist = {static_entries, 0, 0};
Tim Petersf4331c12001-10-27 00:17:34 +00001443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 assert(args != NULL && PyTuple_Check(args));
1445 assert(keywords == NULL || PyDict_Check(keywords));
1446 assert(format != NULL);
1447 assert(kwlist != NULL);
1448 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 /* grab the function name or custom error msg first (mutually exclusive) */
1451 fname = strchr(format, ':');
1452 if (fname) {
1453 fname++;
1454 custom_msg = NULL;
1455 }
1456 else {
1457 custom_msg = strchr(format,';');
1458 if (custom_msg)
1459 custom_msg++;
1460 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001461
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001462 /* scan kwlist and get greatest possible nbr of args */
1463 for (len=0; kwlist[len]; len++)
1464 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001465
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001466 if (len > STATIC_FREELIST_ENTRIES) {
1467 freelist.entries = PyMem_NEW(freelistentry_t, len);
1468 if (freelist.entries == NULL) {
1469 PyErr_NoMemory();
1470 return 0;
1471 }
1472 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001473 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001475 nargs = PyTuple_GET_SIZE(args);
1476 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1477 if (nargs + nkeywords > len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +01001478 PyErr_Format(PyExc_TypeError,
Victor Stinnercb29ec52013-11-18 02:05:31 +01001479 "%s%s takes at most %d argument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 (fname == NULL) ? "function" : fname,
1481 (fname == NULL) ? "" : "()",
1482 len,
1483 (len == 1) ? "" : "s",
1484 nargs + nkeywords);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001485 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001486 }
Tim Petersc2f01122001-10-27 07:25:06 +00001487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001488 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1489 for (i = 0; i < len; i++) {
1490 keyword = kwlist[i];
1491 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001492 if (min != INT_MAX) {
1493 PyErr_SetString(PyExc_RuntimeError,
1494 "Invalid format string (| specified twice)");
1495 return cleanreturn(0, &freelist);
1496 }
1497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 min = i;
1499 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001500
1501 if (max != INT_MAX) {
1502 PyErr_SetString(PyExc_RuntimeError,
1503 "Invalid format string ($ before |)");
1504 return cleanreturn(0, &freelist);
1505 }
1506 }
1507 if (*format == '$') {
1508 if (max != INT_MAX) {
1509 PyErr_SetString(PyExc_RuntimeError,
1510 "Invalid format string ($ specified twice)");
1511 return cleanreturn(0, &freelist);
1512 }
1513
1514 max = i;
1515 format++;
1516
1517 if (max < nargs) {
1518 PyErr_Format(PyExc_TypeError,
1519 "Function takes %s %d positional arguments"
1520 " (%d given)",
1521 (min != INT_MAX) ? "at most" : "exactly",
1522 max, nargs);
1523 return cleanreturn(0, &freelist);
1524 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 }
1526 if (IS_END_OF_FORMAT(*format)) {
1527 PyErr_Format(PyExc_RuntimeError,
1528 "More keyword list entries (%d) than "
1529 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001530 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001531 }
1532 current_arg = NULL;
1533 if (nkeywords) {
1534 current_arg = PyDict_GetItemString(keywords, keyword);
1535 }
1536 if (current_arg) {
1537 --nkeywords;
1538 if (i < nargs) {
1539 /* arg present in tuple and in dict */
1540 PyErr_Format(PyExc_TypeError,
1541 "Argument given by name ('%s') "
1542 "and position (%d)",
1543 keyword, i+1);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001544 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 }
1546 }
1547 else if (nkeywords && PyErr_Occurred())
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001548 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 else if (i < nargs)
1550 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimes380f7f22008-02-28 11:19:05 +00001551
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001552 if (current_arg) {
1553 msg = convertitem(current_arg, &format, p_va, flags,
1554 levels, msgbuf, sizeof(msgbuf), &freelist);
1555 if (msg) {
1556 seterror(i+1, msg, levels, fname, custom_msg);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001557 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 }
1559 continue;
1560 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001561
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 if (i < min) {
1563 PyErr_Format(PyExc_TypeError, "Required argument "
1564 "'%s' (pos %d) not found",
1565 keyword, i+1);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001566 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 }
1568 /* current code reports success when all required args
1569 * fulfilled and no keyword args left, with no further
1570 * validation. XXX Maybe skip this in debug build ?
1571 */
1572 if (!nkeywords)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001573 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001574
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001575 /* We are into optional args, skip thru to any remaining
1576 * keyword args */
1577 msg = skipitem(&format, p_va, flags);
1578 if (msg) {
1579 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1580 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001581 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001582 }
1583 }
Tim Petersb054be42001-10-27 05:07:41 +00001584
Larry Hastings83a9f482012-03-20 20:06:16 +00001585 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 PyErr_Format(PyExc_RuntimeError,
1587 "more argument specifiers than keyword list entries "
1588 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001589 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 }
Tim Petersc2f01122001-10-27 07:25:06 +00001591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001592 /* make sure there are no extraneous keyword arguments */
1593 if (nkeywords > 0) {
1594 PyObject *key, *value;
1595 Py_ssize_t pos = 0;
1596 while (PyDict_Next(keywords, &pos, &key, &value)) {
1597 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 if (!PyUnicode_Check(key)) {
1599 PyErr_SetString(PyExc_TypeError,
1600 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001601 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001603 for (i = 0; i < len; i++) {
1604 if (!PyUnicode_CompareWithASCIIString(key, kwlist[i])) {
1605 match = 1;
1606 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 }
1608 }
1609 if (!match) {
1610 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001611 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001613 key);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001614 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 }
1616 }
1617 }
1618
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001619 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001620}
1621
1622
1623static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001624skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001625{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001626 const char *format = *p_format;
1627 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001628
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001630
Larry Hastingsa3479012012-05-08 23:52:03 -07001631 /*
1632 * codes that take a single data pointer as an argument
1633 * (the type of the pointer is irrelevant)
1634 */
Georg Brandl6dd14612005-09-14 19:29:53 +00001635
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 case 'b': /* byte -- very short int */
1637 case 'B': /* byte as bitfield */
1638 case 'h': /* short int */
1639 case 'H': /* short int as bitfield */
1640 case 'i': /* int */
1641 case 'I': /* int sized bitfield */
1642 case 'l': /* long int */
1643 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001644#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 case 'L': /* PY_LONG_LONG */
1646 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001647#endif
Larry Hastingsa3479012012-05-08 23:52:03 -07001648 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001649 case 'f': /* float */
1650 case 'd': /* double */
1651 case 'D': /* complex double */
1652 case 'c': /* char */
1653 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07001654 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07001655 case 'S': /* string object */
1656 case 'Y': /* string object */
1657 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 {
1659 (void) va_arg(*p_va, void *);
1660 break;
1661 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001662
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001663 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001664
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 case 'e': /* string with encoding */
1666 {
1667 (void) va_arg(*p_va, const char *);
1668 if (!(*format == 's' || *format == 't'))
1669 /* after 'e', only 's' and 't' is allowed */
1670 goto err;
1671 format++;
1672 /* explicit fallthrough to string cases */
1673 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 case 's': /* string */
1676 case 'z': /* string or None */
1677 case 'y': /* bytes */
1678 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07001679 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 case 'w': /* buffer, read-write */
1681 {
1682 (void) va_arg(*p_va, char **);
1683 if (*format == '#') {
1684 if (flags & FLAG_SIZE_T)
1685 (void) va_arg(*p_va, Py_ssize_t *);
1686 else
1687 (void) va_arg(*p_va, int *);
1688 format++;
1689 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1690 format++;
1691 }
1692 break;
1693 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 case 'O': /* object */
1696 {
1697 if (*format == '!') {
1698 format++;
1699 (void) va_arg(*p_va, PyTypeObject*);
1700 (void) va_arg(*p_va, PyObject **);
1701 }
1702 else if (*format == '&') {
1703 typedef int (*converter)(PyObject *, void *);
1704 (void) va_arg(*p_va, converter);
1705 (void) va_arg(*p_va, void *);
1706 format++;
1707 }
1708 else {
1709 (void) va_arg(*p_va, PyObject **);
1710 }
1711 break;
1712 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001713
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001714 case '(': /* bypass tuple, not handled at all previously */
1715 {
1716 char *msg;
1717 for (;;) {
1718 if (*format==')')
1719 break;
1720 if (IS_END_OF_FORMAT(*format))
1721 return "Unmatched left paren in format "
1722 "string";
1723 msg = skipitem(&format, p_va, flags);
1724 if (msg)
1725 return msg;
1726 }
1727 format++;
1728 break;
1729 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001730
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001731 case ')':
1732 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00001733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001735err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001736 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001737
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001738 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001740 *p_format = format;
1741 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001742}
Fred Drakee4616e62001-10-23 21:09:29 +00001743
1744
1745int
Martin v. Löwis76246742006-03-01 04:06:10 +00001746PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001747{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001748 Py_ssize_t i, l;
1749 PyObject **o;
1750 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001751
1752#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001753 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001754#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001755 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001756#endif
1757
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001758 assert(min >= 0);
1759 assert(min <= max);
1760 if (!PyTuple_Check(args)) {
Christian Heimes48d8d212012-09-10 13:16:45 +02001761 va_end(vargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001762 PyErr_SetString(PyExc_SystemError,
1763 "PyArg_UnpackTuple() argument list is not a tuple");
1764 return 0;
1765 }
1766 l = PyTuple_GET_SIZE(args);
1767 if (l < min) {
1768 if (name != NULL)
1769 PyErr_Format(
1770 PyExc_TypeError,
1771 "%s expected %s%zd arguments, got %zd",
1772 name, (min == max ? "" : "at least "), min, l);
1773 else
1774 PyErr_Format(
1775 PyExc_TypeError,
1776 "unpacked tuple should have %s%zd elements,"
1777 " but has %zd",
1778 (min == max ? "" : "at least "), min, l);
1779 va_end(vargs);
1780 return 0;
1781 }
1782 if (l > max) {
1783 if (name != NULL)
1784 PyErr_Format(
1785 PyExc_TypeError,
1786 "%s expected %s%zd arguments, got %zd",
1787 name, (min == max ? "" : "at most "), max, l);
1788 else
1789 PyErr_Format(
1790 PyExc_TypeError,
1791 "unpacked tuple should have %s%zd elements,"
1792 " but has %zd",
1793 (min == max ? "" : "at most "), max, l);
1794 va_end(vargs);
1795 return 0;
1796 }
1797 for (i = 0; i < l; i++) {
1798 o = va_arg(vargs, PyObject **);
1799 *o = PyTuple_GET_ITEM(args, i);
1800 }
1801 va_end(vargs);
1802 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001803}
Georg Brandl02c42872005-08-26 06:42:30 +00001804
1805
1806/* For type constructors that don't take keyword args
1807 *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001808 * Sets a TypeError and returns 0 if the kwds dict is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001809 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001810 */
1811int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001812_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001813{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001814 if (kw == NULL)
1815 return 1;
1816 if (!PyDict_CheckExact(kw)) {
1817 PyErr_BadInternalCall();
1818 return 0;
1819 }
1820 if (PyDict_Size(kw) == 0)
1821 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001822
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001823 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1824 funcname);
1825 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001826}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001827#ifdef __cplusplus
1828};
1829#endif